From b674a1c81a6fd6dda306cf469ab0cb89683f423c Mon Sep 17 00:00:00 2001 From: therve Date: Mon, 10 May 2021 15:31:02 +0000 Subject: [PATCH] Regenerate client from commit b9a2b4b of spec repo (#426) Co-authored-by: ci.datadog-api-spec 05c778958457242aa8ba476354e749ddd323ddb3 --- search/search_index.json | 2 +- v1/SyntheticsApi/index.html | 10 +++++----- v1/SyntheticsTestConfig/index.html | 2 +- v1/SyntheticsTickInterval/index.html | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/search/search_index.json b/search/search_index.json index 547a368c66..16d35d8be6 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"datadog-api-client-python This repository contains a Python API client for the Datadog API . The code is generated using openapi-generator and apigentools . Requirements Building and using the API client library requires Python 3.6+ . Installation To install the API client library, simply execute: pip install datadog-api-client Getting Started Please follow the installation instruction and execute the following Python code: import os from dateutil.parser import parse as dateutil_parser import datadog_api_client.v1 from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # Defining the host is optional and defaults to https://api.datadoghq.com # See configuration.py for a list of all supported configuration parameters. configuration = datadog_api_client.v1.Configuration( host = \"https://api.datadoghq.com\" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: apiKeyAuth configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY') # Configure API key authorization: appKeyAuth configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY') # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e) Unstable Endpoints This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints: configuration.unstable_operations[\"\"] = True where is the name of the method used to interact with that endpoint. For example: list_log_indexes , or get_logs_index Documentation for API Endpoints and Models Documentation for API endpoints and models can be found under the docs subdirectories, in v1 and v2 . It's also available on readthedocs . Documentation for Authorization Authenticate with the API by providing your API and Application keys in the configuration: configuration.api_key[\"apiKeyAuth\"] = \"YOUR_API_KEY\" configuration.api_key[\"appKeyAuth\"] = \"YOUR_APPLICATION_KEY\" Author support@datadoghq.com","title":"datadog-api-client-python"},{"location":"#datadog-api-client-python","text":"This repository contains a Python API client for the Datadog API . The code is generated using openapi-generator and apigentools .","title":"datadog-api-client-python"},{"location":"#requirements","text":"Building and using the API client library requires Python 3.6+ .","title":"Requirements"},{"location":"#installation","text":"To install the API client library, simply execute: pip install datadog-api-client","title":"Installation"},{"location":"#getting-started","text":"Please follow the installation instruction and execute the following Python code: import os from dateutil.parser import parse as dateutil_parser import datadog_api_client.v1 from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # Defining the host is optional and defaults to https://api.datadoghq.com # See configuration.py for a list of all supported configuration parameters. configuration = datadog_api_client.v1.Configuration( host = \"https://api.datadoghq.com\" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: apiKeyAuth configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY') # Configure API key authorization: appKeyAuth configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY') # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e)","title":"Getting Started"},{"location":"#unstable-endpoints","text":"This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints: configuration.unstable_operations[\"\"] = True where is the name of the method used to interact with that endpoint. For example: list_log_indexes , or get_logs_index","title":"Unstable Endpoints"},{"location":"#documentation-for-api-endpoints-and-models","text":"Documentation for API endpoints and models can be found under the docs subdirectories, in v1 and v2 . It's also available on readthedocs .","title":"Documentation for API Endpoints and Models"},{"location":"#documentation-for-authorization","text":"Authenticate with the API by providing your API and Application keys in the configuration: configuration.api_key[\"apiKeyAuth\"] = \"YOUR_API_KEY\" configuration.api_key[\"appKeyAuth\"] = \"YOUR_APPLICATION_KEY\"","title":"Documentation for Authorization"},{"location":"#author","text":"support@datadoghq.com","title":"Author"},{"location":"v1/","text":"datadog-api-client.v1 Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/ Requirements. Python >= 3.6 Installation & Usage pip install If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v1 Setuptools Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v1 Getting Started Please follow the installation procedure and then run the following: import time import datadog_api_client.v1 from pprint import pprint from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.model.api_error_response import APIErrorResponse from datadog_api_client.v1.model.aws_account import AWSAccount from datadog_api_client.v1.model.aws_account_create_response import AWSAccountCreateResponse from datadog_api_client.v1.model.aws_account_list_response import AWSAccountListResponse from datadog_api_client.v1.model.aws_tag_filter_create_request import AWSTagFilterCreateRequest from datadog_api_client.v1.model.aws_tag_filter_delete_request import AWSTagFilterDeleteRequest from datadog_api_client.v1.model.aws_tag_filter_list_response import AWSTagFilterListResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e) Documentation for API Endpoints All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description AWSIntegrationApi create_aws_account POST /api/v1/integration/aws Create an AWS integration AWSIntegrationApi create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter AWSIntegrationApi create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID AWSIntegrationApi delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration AWSIntegrationApi delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry AWSIntegrationApi list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules AWSIntegrationApi list_aws_accounts GET /api/v1/integration/aws List all AWS integrations AWSIntegrationApi list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters AWSIntegrationApi update_aws_account PUT /api/v1/integration/aws Update an AWS integration AWSLogsIntegrationApi check_aws_logs_lambda_async POST /api/v1/integration/aws/logs/check_async Check that an AWS Lambda Function exists AWSLogsIntegrationApi check_aws_logs_services_async POST /api/v1/integration/aws/logs/services_async Check permissions for log services AWSLogsIntegrationApi create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN AWSLogsIntegrationApi delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration AWSLogsIntegrationApi enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration AWSLogsIntegrationApi list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations AWSLogsIntegrationApi list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services AuthenticationApi validate GET /api/v1/validate Validate API key AzureIntegrationApi create_azure_integration POST /api/v1/integration/azure Create an Azure integration AzureIntegrationApi delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration AzureIntegrationApi list_azure_integration GET /api/v1/integration/azure List all Azure integrations AzureIntegrationApi update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters AzureIntegrationApi update_azure_integration PUT /api/v1/integration/azure Update an Azure integration DashboardListsApi create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list DashboardListsApi delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list DashboardListsApi get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list DashboardListsApi list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists DashboardListsApi update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list DashboardsApi create_dashboard POST /api/v1/dashboard Create a new dashboard DashboardsApi delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard DashboardsApi get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard DashboardsApi list_dashboards GET /api/v1/dashboard Get all dashboards DashboardsApi update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard DowntimesApi cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime DowntimesApi cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope DowntimesApi create_downtime POST /api/v1/downtime Schedule a downtime DowntimesApi get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime DowntimesApi list_downtimes GET /api/v1/downtime Get all downtimes DowntimesApi list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor DowntimesApi update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime EventsApi create_event POST /api/v1/events Post an event EventsApi get_event GET /api/v1/events/{event_id} Get an event EventsApi list_events GET /api/v1/events Query the event stream GCPIntegrationApi create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration GCPIntegrationApi delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration GCPIntegrationApi list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations GCPIntegrationApi update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration HostsApi get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts HostsApi list_hosts GET /api/v1/hosts Get all hosts for your organization HostsApi mute_host POST /api/v1/host/{host_name}/mute Mute a host HostsApi unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host IPRangesApi get_ip_ranges GET / List IP Ranges KeyManagementApi create_api_key POST /api/v1/api_key Create an API key KeyManagementApi create_application_key POST /api/v1/application_key Create an application key KeyManagementApi delete_api_key DELETE /api/v1/api_key/{key} Delete an API key KeyManagementApi delete_application_key DELETE /api/v1/application_key/{key} Delete an application key KeyManagementApi get_api_key GET /api/v1/api_key/{key} Get API key KeyManagementApi get_application_key GET /api/v1/application_key/{key} Get an application key KeyManagementApi list_api_keys GET /api/v1/api_key Get all API keys KeyManagementApi list_application_keys GET /api/v1/application_key Get all application keys KeyManagementApi update_api_key PUT /api/v1/api_key/{key} Edit an API key KeyManagementApi update_application_key PUT /api/v1/application_key/{key} Edit an application key LogsApi list_logs POST /api/v1/logs-queries/list Search logs LogsApi submit_log POST /v1/input Send logs LogsIndexesApi create_logs_index POST /api/v1/logs/config/indexes Create an index LogsIndexesApi get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index LogsIndexesApi get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order LogsIndexesApi list_log_indexes GET /api/v1/logs/config/indexes Get all indexes LogsIndexesApi update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index LogsIndexesApi update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order LogsPipelinesApi create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline LogsPipelinesApi delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline LogsPipelinesApi get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline LogsPipelinesApi get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order LogsPipelinesApi list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines LogsPipelinesApi update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline LogsPipelinesApi update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order MetricsApi get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata MetricsApi list_active_metrics GET /api/v1/metrics Get active metrics list MetricsApi list_metrics GET /api/v1/search Search metrics MetricsApi query_metrics GET /api/v1/query Query timeseries points MetricsApi submit_metrics POST /api/v1/series Submit metrics MetricsApi update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata MonitorsApi check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted MonitorsApi create_monitor POST /api/v1/monitor Create a monitor MonitorsApi delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor MonitorsApi get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details MonitorsApi list_monitors GET /api/v1/monitor Get all monitor details MonitorsApi update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor MonitorsApi validate_monitor POST /api/v1/monitor/validate Validate a monitor OrganizationsApi create_child_org POST /api/v1/org Create a child organization OrganizationsApi get_org GET /api/v1/org/{public_id} Get organization information OrganizationsApi list_orgs GET /api/v1/org List your managed organizations OrganizationsApi update_org PUT /api/v1/org/{public_id} Update your organization OrganizationsApi upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata PagerDutyIntegrationApi create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object PagerDutyIntegrationApi delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object PagerDutyIntegrationApi get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object PagerDutyIntegrationApi update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object ServiceChecksApi submit_service_check POST /api/v1/check_run Submit a Service Check ServiceLevelObjectiveCorrectionsApi create_slo_correction POST /api/v1/slo/correction Create an SLO correction ServiceLevelObjectiveCorrectionsApi delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction ServiceLevelObjectiveCorrectionsApi get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO ServiceLevelObjectiveCorrectionsApi list_slo_correction GET /api/v1/slo/correction Get all SLO corrections ServiceLevelObjectiveCorrectionsApi update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction ServiceLevelObjectivesApi check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted ServiceLevelObjectivesApi create_slo POST /api/v1/slo Create an SLO object ServiceLevelObjectivesApi delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO ServiceLevelObjectivesApi delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes ServiceLevelObjectivesApi get_slo GET /api/v1/slo/{slo_id} Get an SLO's details ServiceLevelObjectivesApi get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history ServiceLevelObjectivesApi list_slos GET /api/v1/slo Get all SLOs ServiceLevelObjectivesApi update_slo PUT /api/v1/slo/{slo_id} Update an SLO SlackIntegrationApi create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel SlackIntegrationApi get_slack_integration_channel GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Get a Slack integration channel SlackIntegrationApi get_slack_integration_channels GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration SlackIntegrationApi remove_slack_integration_channel DELETE /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Remove a Slack integration channel SlackIntegrationApi update_slack_integration_channel PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel SnapshotsApi get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots SyntheticsApi create_global_variable POST /api/v1/synthetics/variables Create a global variable SyntheticsApi create_private_location POST /api/v1/synthetics/private-locations Create a private location SyntheticsApi create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test SyntheticsApi create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test SyntheticsApi delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable SyntheticsApi delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location SyntheticsApi delete_tests POST /api/v1/synthetics/tests/delete Delete tests SyntheticsApi edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable SyntheticsApi get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test SyntheticsApi get_api_test_latest_results GET /api/v1/synthetics/tests/{public_id}/results Get an API test's latest results summaries SyntheticsApi get_api_test_result GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result SyntheticsApi get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test SyntheticsApi get_browser_test_latest_results GET /api/v1/synthetics/tests/browser/{public_id}/results Get a browser test's latest results summaries SyntheticsApi get_browser_test_result GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result SyntheticsApi get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable SyntheticsApi get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location SyntheticsApi get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration SyntheticsApi list_locations GET /api/v1/synthetics/locations Get all locations (public and private) SyntheticsApi list_tests GET /api/v1/synthetics/tests Get the list of all tests SyntheticsApi trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines SyntheticsApi update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test SyntheticsApi update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test SyntheticsApi update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location SyntheticsApi update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test TagsApi create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host TagsApi delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags TagsApi get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags TagsApi list_host_tags GET /api/v1/tags/hosts Get Tags TagsApi update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags UsageMeteringApi get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports UsageMeteringApi get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management UsageMeteringApi get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans UsageMeteringApi get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports UsageMeteringApi get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports UsageMeteringApi get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports UsageMeteringApi get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits UsageMeteringApi get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs UsageMeteringApi get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution UsageMeteringApi get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account UsageMeteringApi get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring UsageMeteringApi get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate UsageMeteringApi get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers UsageMeteringApi get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans UsageMeteringApi get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT UsageMeteringApi get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda UsageMeteringApi get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs UsageMeteringApi get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index UsageMeteringApi get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention UsageMeteringApi get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows UsageMeteringApi get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts UsageMeteringApi get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts UsageMeteringApi get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions UsageMeteringApi get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices UsageMeteringApi get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account UsageMeteringApi get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks UsageMeteringApi get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks UsageMeteringApi get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks UsageMeteringApi get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics UsageMeteringApi get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average UsageMeteringApi get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search UsersApi create_user POST /api/v1/user Create a user UsersApi disable_user DELETE /api/v1/user/{user_handle} Disable a user UsersApi get_user GET /api/v1/user/{user_handle} Get user details UsersApi list_users GET /api/v1/user List all users UsersApi update_user PUT /api/v1/user/{user_handle} Update a user Documentation For Models APIErrorResponse AWSAccount AWSAccountAndLambdaRequest AWSAccountCreateResponse AWSAccountListResponse AWSLogsAsyncError AWSLogsAsyncResponse AWSLogsLambda AWSLogsListResponse AWSLogsListServicesResponse AWSLogsServicesRequest AWSNamespace AWSTagFilter AWSTagFilterCreateRequest AWSTagFilterDeleteRequest AWSTagFilterListResponse AccessRole AlertGraphWidgetDefinition AlertGraphWidgetDefinitionType AlertValueWidgetDefinition AlertValueWidgetDefinitionType ApiKey ApiKeyListResponse ApiKeyResponse ApmStatsQueryColumnType ApmStatsQueryDefinition ApmStatsQueryRowType ApplicationKey ApplicationKeyListResponse ApplicationKeyResponse AuthenticationValidationResponse AzureAccount AzureAccountListResponse CancelDowntimesByScopeRequest CanceledDowntimesIds ChangeWidgetDefinition ChangeWidgetDefinitionType ChangeWidgetRequest CheckCanDeleteMonitorResponse CheckCanDeleteMonitorResponseData CheckCanDeleteSLOResponse CheckCanDeleteSLOResponseData CheckStatusWidgetDefinition CheckStatusWidgetDefinitionType ContentEncoding Creator Dashboard DashboardDeleteResponse DashboardLayoutType DashboardList DashboardListDeleteResponse DashboardListListResponse DashboardReflowType DashboardSummary DashboardSummaryDefinition DashboardTemplateVariable DashboardTemplateVariablePreset DashboardTemplateVariablePresetValue DeletedMonitor DistributionWidgetDefinition DistributionWidgetDefinitionType DistributionWidgetRequest DistributionWidgetXAxis DistributionWidgetYAxis Downtime DowntimeRecurrence Event EventAlertType EventCreateRequest EventCreateResponse EventListResponse EventPriority EventQueryDefinition EventResponse EventStreamWidgetDefinition EventStreamWidgetDefinitionType EventTimelineWidgetDefinition EventTimelineWidgetDefinitionType FormulaAndFunctionEventAggregation FormulaAndFunctionEventQueryDefinition FormulaAndFunctionEventQueryDefinitionCompute FormulaAndFunctionEventQueryDefinitionSearch FormulaAndFunctionEventQueryGroupBy FormulaAndFunctionEventQueryGroupBySort FormulaAndFunctionEventsDataSource FormulaAndFunctionMetricAggregation FormulaAndFunctionMetricDataSource FormulaAndFunctionMetricQueryDefinition FormulaAndFunctionProcessQueryDataSource FormulaAndFunctionProcessQueryDefinition FormulaAndFunctionQueryDefinition FormulaAndFunctionResponseFormat FreeTextWidgetDefinition FreeTextWidgetDefinitionType GCPAccount GCPAccountListResponse GeomapWidgetDefinition GeomapWidgetDefinitionStyle GeomapWidgetDefinitionType GeomapWidgetDefinitionView GeomapWidgetRequest GraphSnapshot GroupWidgetDefinition GroupWidgetDefinitionType HTTPLog HTTPLogError HTTPLogItem HTTPMethod HeatMapWidgetDefinition HeatMapWidgetDefinitionType HeatMapWidgetRequest Host HostListResponse HostMapRequest HostMapWidgetDefinition HostMapWidgetDefinitionRequests HostMapWidgetDefinitionStyle HostMapWidgetDefinitionType HostMeta HostMetrics HostMuteResponse HostMuteSettings HostTags HostTotals IFrameWidgetDefinition IFrameWidgetDefinitionType IPPrefixesAPI IPPrefixesAPM IPPrefixesAgents IPPrefixesLogs IPPrefixesProcess IPPrefixesSynthetics IPPrefixesWebhooks IPRanges IdpFormData IdpResponse ImageWidgetDefinition ImageWidgetDefinitionType IntakePayloadAccepted Log LogContent LogQueryDefinition LogQueryDefinitionGroupBy LogQueryDefinitionGroupBySort LogQueryDefinitionSearch LogStreamWidgetDefinition LogStreamWidgetDefinitionType LogsAPIError LogsAPIErrorResponse LogsArithmeticProcessor LogsArithmeticProcessorType LogsAttributeRemapper LogsAttributeRemapperType LogsByRetention LogsByRetentionMonthlyUsage LogsByRetentionOrgUsage LogsByRetentionOrgs LogsCategoryProcessor LogsCategoryProcessorCategory LogsCategoryProcessorType LogsDateRemapper LogsDateRemapperType LogsExclusion LogsExclusionFilter LogsFilter LogsGeoIPParser LogsGeoIPParserType LogsGrokParser LogsGrokParserRules LogsGrokParserType LogsIndex LogsIndexListResponse LogsIndexUpdateRequest LogsIndexesOrder LogsListRequest LogsListRequestTime LogsListResponse LogsLookupProcessor LogsLookupProcessorType LogsMessageRemapper LogsMessageRemapperType LogsPipeline LogsPipelineList LogsPipelineProcessor LogsPipelineProcessorType LogsPipelinesOrder LogsProcessor LogsQueryCompute LogsRetentionAggSumUsage LogsRetentionSumUsage LogsServiceRemapper LogsServiceRemapperType LogsSort LogsStatusRemapper LogsStatusRemapperType LogsStringBuilderProcessor LogsStringBuilderProcessorType LogsTraceRemapper LogsTraceRemapperType LogsURLParser LogsURLParserType LogsUserAgentParser LogsUserAgentParserType MetricMetadata MetricSearchResponse MetricSearchResponseResults MetricsListResponse MetricsPayload MetricsQueryMetadata MetricsQueryResponse MetricsQueryUnit Monitor MonitorDeviceID MonitorOptions MonitorOptionsAggregation MonitorOverallStates MonitorState MonitorStateGroup MonitorSummaryWidgetDefinition MonitorSummaryWidgetDefinitionType MonitorThresholdWindowOptions MonitorThresholds MonitorType MonitorUpdateRequest NoteWidgetDefinition NoteWidgetDefinitionType Organization OrganizationBilling OrganizationCreateBody OrganizationCreateResponse OrganizationListResponse OrganizationResponse OrganizationSettings OrganizationSettingsSaml OrganizationSettingsSamlAutocreateUsersDomains OrganizationSettingsSamlIdpInitiatedLogin OrganizationSettingsSamlStrictMode OrganizationSubscription PagerDutyService PagerDutyServiceKey PagerDutyServiceName Point ProcessQueryDefinition QuerySortOrder QueryValueWidgetDefinition QueryValueWidgetDefinitionType QueryValueWidgetRequest SLOBulkDelete SLOBulkDeleteError SLOBulkDeleteResponse SLOBulkDeleteResponseData SLOCorrection SLOCorrectionCategory SLOCorrectionCreateData SLOCorrectionCreateRequest SLOCorrectionCreateRequestAttributes SLOCorrectionListResponse SLOCorrectionResponse SLOCorrectionResponseAttributes SLOCorrectionType SLOCorrectionUpdateData SLOCorrectionUpdateRequest SLOCorrectionUpdateRequestAttributes SLODeleteResponse SLOErrorBudgetRemainingData SLOErrorTimeframe SLOHistoryMetrics SLOHistoryMetricsSeries SLOHistoryMetricsSeriesMetadata SLOHistoryMetricsSeriesMetadataUnit SLOHistoryResponse SLOHistoryResponseData SLOHistoryResponseError SLOHistorySLIData SLOListResponse SLOListResponseMetadata SLOListResponseMetadataPage SLOResponse SLOResponseData SLOThreshold SLOTimeframe SLOType SLOTypeNumeric SLOWidgetDefinition SLOWidgetDefinitionType ScatterPlotRequest ScatterPlotWidgetDefinition ScatterPlotWidgetDefinitionRequests ScatterPlotWidgetDefinitionType Series ServiceCheck ServiceCheckStatus ServiceChecks ServiceLevelObjective ServiceLevelObjectiveQuery ServiceLevelObjectiveRequest ServiceMapWidgetDefinition ServiceMapWidgetDefinitionType ServiceSummaryWidgetDefinition ServiceSummaryWidgetDefinitionType SlackIntegrationChannel SlackIntegrationChannelDisplay SlackIntegrationChannels SyntheticsAPIStep SyntheticsAPIStepSubtype SyntheticsAPITest SyntheticsAPITestConfig SyntheticsAPITestResultData SyntheticsAPITestResultFull SyntheticsAPITestResultFullCheck SyntheticsAPITestResultShort SyntheticsAPITestResultShortResult SyntheticsAPITestType SyntheticsAssertion SyntheticsAssertionJSONPathOperator SyntheticsAssertionJSONPathTarget SyntheticsAssertionJSONPathTargetTarget SyntheticsAssertionOperator SyntheticsAssertionTarget SyntheticsAssertionType SyntheticsBasicAuth SyntheticsBrowserError SyntheticsBrowserErrorType SyntheticsBrowserTest SyntheticsBrowserTestConfig SyntheticsBrowserTestResultData SyntheticsBrowserTestResultFull SyntheticsBrowserTestResultFullCheck SyntheticsBrowserTestResultShort SyntheticsBrowserTestResultShortResult SyntheticsBrowserTestType SyntheticsBrowserVariable SyntheticsBrowserVariableType SyntheticsCITest SyntheticsCITestBody SyntheticsCITestMetadata SyntheticsCITestMetadataCi SyntheticsCITestMetadataGit SyntheticsCheckType SyntheticsConfigVariable SyntheticsConfigVariableType SyntheticsCoreWebVitals SyntheticsDeleteTestsPayload SyntheticsDeleteTestsResponse SyntheticsDeletedTest SyntheticsDevice SyntheticsDeviceID SyntheticsErrorCode SyntheticsGetAPITestLatestResultsResponse SyntheticsGetBrowserTestLatestResultsResponse SyntheticsGlobalVariable SyntheticsGlobalVariableParseTestOptions SyntheticsGlobalVariableParseTestOptionsType SyntheticsGlobalVariableParserType SyntheticsGlobalVariableValue SyntheticsListTestsResponse SyntheticsLocation SyntheticsLocations SyntheticsParsingOptions SyntheticsPlayingTab SyntheticsPrivateLocation SyntheticsPrivateLocationCreationResponse SyntheticsPrivateLocationCreationResponseResultEncryption SyntheticsPrivateLocationSecrets SyntheticsPrivateLocationSecretsAuthentication SyntheticsPrivateLocationSecretsConfigDecryption SyntheticsSSLCertificate SyntheticsSSLCertificateIssuer SyntheticsSSLCertificateSubject SyntheticsStep SyntheticsStepDetail SyntheticsStepDetailWarning SyntheticsStepType SyntheticsTestConfig SyntheticsTestDetails SyntheticsTestDetailsSubType SyntheticsTestDetailsType SyntheticsTestHeaders SyntheticsTestMonitorStatus SyntheticsTestOptions SyntheticsTestOptionsMonitorOptions SyntheticsTestOptionsRetry SyntheticsTestPauseStatus SyntheticsTestProcessStatus SyntheticsTestRequest SyntheticsTestRequestCertificate SyntheticsTestRequestCertificateItem SyntheticsTickInterval SyntheticsTiming SyntheticsTriggerCITestLocation SyntheticsTriggerCITestRunResult SyntheticsTriggerCITestsResponse SyntheticsUpdateTestPauseStatusPayload SyntheticsVariableParser SyntheticsWarningType TableWidgetCellDisplayMode TableWidgetDefinition TableWidgetDefinitionType TableWidgetHasSearchBar TableWidgetRequest TagToHosts TargetFormatType TimeseriesWidgetDefinition TimeseriesWidgetDefinitionType TimeseriesWidgetExpressionAlias TimeseriesWidgetLegendColumn TimeseriesWidgetLegendLayout TimeseriesWidgetRequest ToplistWidgetDefinition ToplistWidgetDefinitionType ToplistWidgetRequest UsageAnalyzedLogsHour UsageAnalyzedLogsResponse UsageAttributionAggregates UsageAttributionAggregatesBody UsageAttributionBody UsageAttributionMetadata UsageAttributionPagination UsageAttributionResponse UsageAttributionSort UsageAttributionTagNames UsageAttributionValues UsageBillableSummaryBody UsageBillableSummaryHour UsageBillableSummaryKeys UsageBillableSummaryResponse UsageComplianceHour UsageComplianceResponse UsageCustomReportsAttributes UsageCustomReportsData UsageCustomReportsMeta UsageCustomReportsPage UsageCustomReportsResponse UsageFargateHour UsageFargateResponse UsageHostHour UsageHostsResponse UsageIncidentManagementHour UsageIncidentManagementResponse UsageIndexedSpansHour UsageIndexedSpansResponse UsageIngestedSpansHour UsageIngestedSpansResponse UsageIoTHour UsageIoTResponse UsageLambdaHour UsageLambdaResponse UsageLogsByIndexHour UsageLogsByIndexResponse UsageLogsByRetentionHour UsageLogsByRetentionResponse UsageLogsHour UsageLogsResponse UsageMetricCategory UsageNetworkFlowsHour UsageNetworkFlowsResponse UsageNetworkHostsHour UsageNetworkHostsResponse UsageProfilingHour UsageProfilingResponse UsageReportsType UsageRumSessionsHour UsageRumSessionsResponse UsageSNMPHour UsageSNMPResponse UsageSort UsageSortDirection UsageSpecifiedCustomReportsAttributes UsageSpecifiedCustomReportsData UsageSpecifiedCustomReportsMeta UsageSpecifiedCustomReportsPage UsageSpecifiedCustomReportsResponse UsageSummaryDate UsageSummaryDateOrg UsageSummaryResponse UsageSyntheticsAPIHour UsageSyntheticsAPIResponse UsageSyntheticsBrowserHour UsageSyntheticsBrowserResponse UsageSyntheticsHour UsageSyntheticsResponse UsageTimeseriesHour UsageTimeseriesResponse UsageTopAvgMetricsHour UsageTopAvgMetricsMetadata UsageTopAvgMetricsResponse UsageTraceHour UsageTraceResponse UsageTracingWithoutLimitsHour UsageTracingWithoutLimitsResponse User UserDisableResponse UserListResponse UserResponse Widget WidgetAggregator WidgetAxis WidgetChangeType WidgetColorPreference WidgetComparator WidgetCompareTo WidgetConditionalFormat WidgetCustomLink WidgetDefinition WidgetDisplayType WidgetEvent WidgetEventSize WidgetFieldSort WidgetFormula WidgetFormulaLimit WidgetGrouping WidgetHorizontalAlign WidgetImageSizing WidgetLayout WidgetLayoutType WidgetLineType WidgetLineWidth WidgetLiveSpan WidgetMargin WidgetMarker WidgetMessageDisplay WidgetMonitorSummaryDisplayFormat WidgetMonitorSummarySort WidgetNodeType WidgetOrderBy WidgetPalette WidgetRequestStyle WidgetServiceSummaryDisplayFormat WidgetSizeFormat WidgetSort WidgetStyle WidgetSummaryType WidgetTextAlign WidgetTickEdge WidgetTime WidgetTimeWindows WidgetVerticalAlign WidgetViewMode WidgetVizType Documentation For Authorization 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 Author support@datadoghq.com Notes for Large OpenAPI documents If the OpenAPI document is large, imports in datadog_api_client.v1.apis and datadog_api_client.v1.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v1.api.default_api import DefaultApi - from datadog_api_client.v1.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v1 from datadog_api_client.v1.apis import * from datadog_api_client.v1.models import *","title":"datadog-api-client.v1"},{"location":"v1/#datadog-api-clientv1","text":"Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/","title":"datadog-api-client.v1"},{"location":"v1/#requirements","text":"Python >= 3.6","title":"Requirements."},{"location":"v1/#installation-usage","text":"","title":"Installation & Usage"},{"location":"v1/#pip-install","text":"If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v1","title":"pip install"},{"location":"v1/#setuptools","text":"Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v1","title":"Setuptools"},{"location":"v1/#getting-started","text":"Please follow the installation procedure and then run the following: import time import datadog_api_client.v1 from pprint import pprint from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.model.api_error_response import APIErrorResponse from datadog_api_client.v1.model.aws_account import AWSAccount from datadog_api_client.v1.model.aws_account_create_response import AWSAccountCreateResponse from datadog_api_client.v1.model.aws_account_list_response import AWSAccountListResponse from datadog_api_client.v1.model.aws_tag_filter_create_request import AWSTagFilterCreateRequest from datadog_api_client.v1.model.aws_tag_filter_delete_request import AWSTagFilterDeleteRequest from datadog_api_client.v1.model.aws_tag_filter_list_response import AWSTagFilterListResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e)","title":"Getting Started"},{"location":"v1/#documentation-for-api-endpoints","text":"All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description AWSIntegrationApi create_aws_account POST /api/v1/integration/aws Create an AWS integration AWSIntegrationApi create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter AWSIntegrationApi create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID AWSIntegrationApi delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration AWSIntegrationApi delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry AWSIntegrationApi list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules AWSIntegrationApi list_aws_accounts GET /api/v1/integration/aws List all AWS integrations AWSIntegrationApi list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters AWSIntegrationApi update_aws_account PUT /api/v1/integration/aws Update an AWS integration AWSLogsIntegrationApi check_aws_logs_lambda_async POST /api/v1/integration/aws/logs/check_async Check that an AWS Lambda Function exists AWSLogsIntegrationApi check_aws_logs_services_async POST /api/v1/integration/aws/logs/services_async Check permissions for log services AWSLogsIntegrationApi create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN AWSLogsIntegrationApi delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration AWSLogsIntegrationApi enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration AWSLogsIntegrationApi list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations AWSLogsIntegrationApi list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services AuthenticationApi validate GET /api/v1/validate Validate API key AzureIntegrationApi create_azure_integration POST /api/v1/integration/azure Create an Azure integration AzureIntegrationApi delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration AzureIntegrationApi list_azure_integration GET /api/v1/integration/azure List all Azure integrations AzureIntegrationApi update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters AzureIntegrationApi update_azure_integration PUT /api/v1/integration/azure Update an Azure integration DashboardListsApi create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list DashboardListsApi delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list DashboardListsApi get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list DashboardListsApi list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists DashboardListsApi update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list DashboardsApi create_dashboard POST /api/v1/dashboard Create a new dashboard DashboardsApi delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard DashboardsApi get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard DashboardsApi list_dashboards GET /api/v1/dashboard Get all dashboards DashboardsApi update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard DowntimesApi cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime DowntimesApi cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope DowntimesApi create_downtime POST /api/v1/downtime Schedule a downtime DowntimesApi get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime DowntimesApi list_downtimes GET /api/v1/downtime Get all downtimes DowntimesApi list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor DowntimesApi update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime EventsApi create_event POST /api/v1/events Post an event EventsApi get_event GET /api/v1/events/{event_id} Get an event EventsApi list_events GET /api/v1/events Query the event stream GCPIntegrationApi create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration GCPIntegrationApi delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration GCPIntegrationApi list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations GCPIntegrationApi update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration HostsApi get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts HostsApi list_hosts GET /api/v1/hosts Get all hosts for your organization HostsApi mute_host POST /api/v1/host/{host_name}/mute Mute a host HostsApi unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host IPRangesApi get_ip_ranges GET / List IP Ranges KeyManagementApi create_api_key POST /api/v1/api_key Create an API key KeyManagementApi create_application_key POST /api/v1/application_key Create an application key KeyManagementApi delete_api_key DELETE /api/v1/api_key/{key} Delete an API key KeyManagementApi delete_application_key DELETE /api/v1/application_key/{key} Delete an application key KeyManagementApi get_api_key GET /api/v1/api_key/{key} Get API key KeyManagementApi get_application_key GET /api/v1/application_key/{key} Get an application key KeyManagementApi list_api_keys GET /api/v1/api_key Get all API keys KeyManagementApi list_application_keys GET /api/v1/application_key Get all application keys KeyManagementApi update_api_key PUT /api/v1/api_key/{key} Edit an API key KeyManagementApi update_application_key PUT /api/v1/application_key/{key} Edit an application key LogsApi list_logs POST /api/v1/logs-queries/list Search logs LogsApi submit_log POST /v1/input Send logs LogsIndexesApi create_logs_index POST /api/v1/logs/config/indexes Create an index LogsIndexesApi get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index LogsIndexesApi get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order LogsIndexesApi list_log_indexes GET /api/v1/logs/config/indexes Get all indexes LogsIndexesApi update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index LogsIndexesApi update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order LogsPipelinesApi create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline LogsPipelinesApi delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline LogsPipelinesApi get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline LogsPipelinesApi get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order LogsPipelinesApi list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines LogsPipelinesApi update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline LogsPipelinesApi update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order MetricsApi get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata MetricsApi list_active_metrics GET /api/v1/metrics Get active metrics list MetricsApi list_metrics GET /api/v1/search Search metrics MetricsApi query_metrics GET /api/v1/query Query timeseries points MetricsApi submit_metrics POST /api/v1/series Submit metrics MetricsApi update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata MonitorsApi check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted MonitorsApi create_monitor POST /api/v1/monitor Create a monitor MonitorsApi delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor MonitorsApi get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details MonitorsApi list_monitors GET /api/v1/monitor Get all monitor details MonitorsApi update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor MonitorsApi validate_monitor POST /api/v1/monitor/validate Validate a monitor OrganizationsApi create_child_org POST /api/v1/org Create a child organization OrganizationsApi get_org GET /api/v1/org/{public_id} Get organization information OrganizationsApi list_orgs GET /api/v1/org List your managed organizations OrganizationsApi update_org PUT /api/v1/org/{public_id} Update your organization OrganizationsApi upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata PagerDutyIntegrationApi create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object PagerDutyIntegrationApi delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object PagerDutyIntegrationApi get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object PagerDutyIntegrationApi update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object ServiceChecksApi submit_service_check POST /api/v1/check_run Submit a Service Check ServiceLevelObjectiveCorrectionsApi create_slo_correction POST /api/v1/slo/correction Create an SLO correction ServiceLevelObjectiveCorrectionsApi delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction ServiceLevelObjectiveCorrectionsApi get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO ServiceLevelObjectiveCorrectionsApi list_slo_correction GET /api/v1/slo/correction Get all SLO corrections ServiceLevelObjectiveCorrectionsApi update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction ServiceLevelObjectivesApi check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted ServiceLevelObjectivesApi create_slo POST /api/v1/slo Create an SLO object ServiceLevelObjectivesApi delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO ServiceLevelObjectivesApi delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes ServiceLevelObjectivesApi get_slo GET /api/v1/slo/{slo_id} Get an SLO's details ServiceLevelObjectivesApi get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history ServiceLevelObjectivesApi list_slos GET /api/v1/slo Get all SLOs ServiceLevelObjectivesApi update_slo PUT /api/v1/slo/{slo_id} Update an SLO SlackIntegrationApi create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel SlackIntegrationApi get_slack_integration_channel GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Get a Slack integration channel SlackIntegrationApi get_slack_integration_channels GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration SlackIntegrationApi remove_slack_integration_channel DELETE /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Remove a Slack integration channel SlackIntegrationApi update_slack_integration_channel PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel SnapshotsApi get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots SyntheticsApi create_global_variable POST /api/v1/synthetics/variables Create a global variable SyntheticsApi create_private_location POST /api/v1/synthetics/private-locations Create a private location SyntheticsApi create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test SyntheticsApi create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test SyntheticsApi delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable SyntheticsApi delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location SyntheticsApi delete_tests POST /api/v1/synthetics/tests/delete Delete tests SyntheticsApi edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable SyntheticsApi get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test SyntheticsApi get_api_test_latest_results GET /api/v1/synthetics/tests/{public_id}/results Get an API test's latest results summaries SyntheticsApi get_api_test_result GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result SyntheticsApi get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test SyntheticsApi get_browser_test_latest_results GET /api/v1/synthetics/tests/browser/{public_id}/results Get a browser test's latest results summaries SyntheticsApi get_browser_test_result GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result SyntheticsApi get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable SyntheticsApi get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location SyntheticsApi get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration SyntheticsApi list_locations GET /api/v1/synthetics/locations Get all locations (public and private) SyntheticsApi list_tests GET /api/v1/synthetics/tests Get the list of all tests SyntheticsApi trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines SyntheticsApi update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test SyntheticsApi update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test SyntheticsApi update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location SyntheticsApi update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test TagsApi create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host TagsApi delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags TagsApi get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags TagsApi list_host_tags GET /api/v1/tags/hosts Get Tags TagsApi update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags UsageMeteringApi get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports UsageMeteringApi get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management UsageMeteringApi get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans UsageMeteringApi get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports UsageMeteringApi get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports UsageMeteringApi get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports UsageMeteringApi get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits UsageMeteringApi get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs UsageMeteringApi get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution UsageMeteringApi get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account UsageMeteringApi get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring UsageMeteringApi get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate UsageMeteringApi get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers UsageMeteringApi get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans UsageMeteringApi get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT UsageMeteringApi get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda UsageMeteringApi get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs UsageMeteringApi get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index UsageMeteringApi get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention UsageMeteringApi get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows UsageMeteringApi get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts UsageMeteringApi get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts UsageMeteringApi get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions UsageMeteringApi get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices UsageMeteringApi get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account UsageMeteringApi get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks UsageMeteringApi get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks UsageMeteringApi get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks UsageMeteringApi get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics UsageMeteringApi get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average UsageMeteringApi get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search UsersApi create_user POST /api/v1/user Create a user UsersApi disable_user DELETE /api/v1/user/{user_handle} Disable a user UsersApi get_user GET /api/v1/user/{user_handle} Get user details UsersApi list_users GET /api/v1/user List all users UsersApi update_user PUT /api/v1/user/{user_handle} Update a user","title":"Documentation for API Endpoints"},{"location":"v1/#documentation-for-models","text":"APIErrorResponse AWSAccount AWSAccountAndLambdaRequest AWSAccountCreateResponse AWSAccountListResponse AWSLogsAsyncError AWSLogsAsyncResponse AWSLogsLambda AWSLogsListResponse AWSLogsListServicesResponse AWSLogsServicesRequest AWSNamespace AWSTagFilter AWSTagFilterCreateRequest AWSTagFilterDeleteRequest AWSTagFilterListResponse AccessRole AlertGraphWidgetDefinition AlertGraphWidgetDefinitionType AlertValueWidgetDefinition AlertValueWidgetDefinitionType ApiKey ApiKeyListResponse ApiKeyResponse ApmStatsQueryColumnType ApmStatsQueryDefinition ApmStatsQueryRowType ApplicationKey ApplicationKeyListResponse ApplicationKeyResponse AuthenticationValidationResponse AzureAccount AzureAccountListResponse CancelDowntimesByScopeRequest CanceledDowntimesIds ChangeWidgetDefinition ChangeWidgetDefinitionType ChangeWidgetRequest CheckCanDeleteMonitorResponse CheckCanDeleteMonitorResponseData CheckCanDeleteSLOResponse CheckCanDeleteSLOResponseData CheckStatusWidgetDefinition CheckStatusWidgetDefinitionType ContentEncoding Creator Dashboard DashboardDeleteResponse DashboardLayoutType DashboardList DashboardListDeleteResponse DashboardListListResponse DashboardReflowType DashboardSummary DashboardSummaryDefinition DashboardTemplateVariable DashboardTemplateVariablePreset DashboardTemplateVariablePresetValue DeletedMonitor DistributionWidgetDefinition DistributionWidgetDefinitionType DistributionWidgetRequest DistributionWidgetXAxis DistributionWidgetYAxis Downtime DowntimeRecurrence Event EventAlertType EventCreateRequest EventCreateResponse EventListResponse EventPriority EventQueryDefinition EventResponse EventStreamWidgetDefinition EventStreamWidgetDefinitionType EventTimelineWidgetDefinition EventTimelineWidgetDefinitionType FormulaAndFunctionEventAggregation FormulaAndFunctionEventQueryDefinition FormulaAndFunctionEventQueryDefinitionCompute FormulaAndFunctionEventQueryDefinitionSearch FormulaAndFunctionEventQueryGroupBy FormulaAndFunctionEventQueryGroupBySort FormulaAndFunctionEventsDataSource FormulaAndFunctionMetricAggregation FormulaAndFunctionMetricDataSource FormulaAndFunctionMetricQueryDefinition FormulaAndFunctionProcessQueryDataSource FormulaAndFunctionProcessQueryDefinition FormulaAndFunctionQueryDefinition FormulaAndFunctionResponseFormat FreeTextWidgetDefinition FreeTextWidgetDefinitionType GCPAccount GCPAccountListResponse GeomapWidgetDefinition GeomapWidgetDefinitionStyle GeomapWidgetDefinitionType GeomapWidgetDefinitionView GeomapWidgetRequest GraphSnapshot GroupWidgetDefinition GroupWidgetDefinitionType HTTPLog HTTPLogError HTTPLogItem HTTPMethod HeatMapWidgetDefinition HeatMapWidgetDefinitionType HeatMapWidgetRequest Host HostListResponse HostMapRequest HostMapWidgetDefinition HostMapWidgetDefinitionRequests HostMapWidgetDefinitionStyle HostMapWidgetDefinitionType HostMeta HostMetrics HostMuteResponse HostMuteSettings HostTags HostTotals IFrameWidgetDefinition IFrameWidgetDefinitionType IPPrefixesAPI IPPrefixesAPM IPPrefixesAgents IPPrefixesLogs IPPrefixesProcess IPPrefixesSynthetics IPPrefixesWebhooks IPRanges IdpFormData IdpResponse ImageWidgetDefinition ImageWidgetDefinitionType IntakePayloadAccepted Log LogContent LogQueryDefinition LogQueryDefinitionGroupBy LogQueryDefinitionGroupBySort LogQueryDefinitionSearch LogStreamWidgetDefinition LogStreamWidgetDefinitionType LogsAPIError LogsAPIErrorResponse LogsArithmeticProcessor LogsArithmeticProcessorType LogsAttributeRemapper LogsAttributeRemapperType LogsByRetention LogsByRetentionMonthlyUsage LogsByRetentionOrgUsage LogsByRetentionOrgs LogsCategoryProcessor LogsCategoryProcessorCategory LogsCategoryProcessorType LogsDateRemapper LogsDateRemapperType LogsExclusion LogsExclusionFilter LogsFilter LogsGeoIPParser LogsGeoIPParserType LogsGrokParser LogsGrokParserRules LogsGrokParserType LogsIndex LogsIndexListResponse LogsIndexUpdateRequest LogsIndexesOrder LogsListRequest LogsListRequestTime LogsListResponse LogsLookupProcessor LogsLookupProcessorType LogsMessageRemapper LogsMessageRemapperType LogsPipeline LogsPipelineList LogsPipelineProcessor LogsPipelineProcessorType LogsPipelinesOrder LogsProcessor LogsQueryCompute LogsRetentionAggSumUsage LogsRetentionSumUsage LogsServiceRemapper LogsServiceRemapperType LogsSort LogsStatusRemapper LogsStatusRemapperType LogsStringBuilderProcessor LogsStringBuilderProcessorType LogsTraceRemapper LogsTraceRemapperType LogsURLParser LogsURLParserType LogsUserAgentParser LogsUserAgentParserType MetricMetadata MetricSearchResponse MetricSearchResponseResults MetricsListResponse MetricsPayload MetricsQueryMetadata MetricsQueryResponse MetricsQueryUnit Monitor MonitorDeviceID MonitorOptions MonitorOptionsAggregation MonitorOverallStates MonitorState MonitorStateGroup MonitorSummaryWidgetDefinition MonitorSummaryWidgetDefinitionType MonitorThresholdWindowOptions MonitorThresholds MonitorType MonitorUpdateRequest NoteWidgetDefinition NoteWidgetDefinitionType Organization OrganizationBilling OrganizationCreateBody OrganizationCreateResponse OrganizationListResponse OrganizationResponse OrganizationSettings OrganizationSettingsSaml OrganizationSettingsSamlAutocreateUsersDomains OrganizationSettingsSamlIdpInitiatedLogin OrganizationSettingsSamlStrictMode OrganizationSubscription PagerDutyService PagerDutyServiceKey PagerDutyServiceName Point ProcessQueryDefinition QuerySortOrder QueryValueWidgetDefinition QueryValueWidgetDefinitionType QueryValueWidgetRequest SLOBulkDelete SLOBulkDeleteError SLOBulkDeleteResponse SLOBulkDeleteResponseData SLOCorrection SLOCorrectionCategory SLOCorrectionCreateData SLOCorrectionCreateRequest SLOCorrectionCreateRequestAttributes SLOCorrectionListResponse SLOCorrectionResponse SLOCorrectionResponseAttributes SLOCorrectionType SLOCorrectionUpdateData SLOCorrectionUpdateRequest SLOCorrectionUpdateRequestAttributes SLODeleteResponse SLOErrorBudgetRemainingData SLOErrorTimeframe SLOHistoryMetrics SLOHistoryMetricsSeries SLOHistoryMetricsSeriesMetadata SLOHistoryMetricsSeriesMetadataUnit SLOHistoryResponse SLOHistoryResponseData SLOHistoryResponseError SLOHistorySLIData SLOListResponse SLOListResponseMetadata SLOListResponseMetadataPage SLOResponse SLOResponseData SLOThreshold SLOTimeframe SLOType SLOTypeNumeric SLOWidgetDefinition SLOWidgetDefinitionType ScatterPlotRequest ScatterPlotWidgetDefinition ScatterPlotWidgetDefinitionRequests ScatterPlotWidgetDefinitionType Series ServiceCheck ServiceCheckStatus ServiceChecks ServiceLevelObjective ServiceLevelObjectiveQuery ServiceLevelObjectiveRequest ServiceMapWidgetDefinition ServiceMapWidgetDefinitionType ServiceSummaryWidgetDefinition ServiceSummaryWidgetDefinitionType SlackIntegrationChannel SlackIntegrationChannelDisplay SlackIntegrationChannels SyntheticsAPIStep SyntheticsAPIStepSubtype SyntheticsAPITest SyntheticsAPITestConfig SyntheticsAPITestResultData SyntheticsAPITestResultFull SyntheticsAPITestResultFullCheck SyntheticsAPITestResultShort SyntheticsAPITestResultShortResult SyntheticsAPITestType SyntheticsAssertion SyntheticsAssertionJSONPathOperator SyntheticsAssertionJSONPathTarget SyntheticsAssertionJSONPathTargetTarget SyntheticsAssertionOperator SyntheticsAssertionTarget SyntheticsAssertionType SyntheticsBasicAuth SyntheticsBrowserError SyntheticsBrowserErrorType SyntheticsBrowserTest SyntheticsBrowserTestConfig SyntheticsBrowserTestResultData SyntheticsBrowserTestResultFull SyntheticsBrowserTestResultFullCheck SyntheticsBrowserTestResultShort SyntheticsBrowserTestResultShortResult SyntheticsBrowserTestType SyntheticsBrowserVariable SyntheticsBrowserVariableType SyntheticsCITest SyntheticsCITestBody SyntheticsCITestMetadata SyntheticsCITestMetadataCi SyntheticsCITestMetadataGit SyntheticsCheckType SyntheticsConfigVariable SyntheticsConfigVariableType SyntheticsCoreWebVitals SyntheticsDeleteTestsPayload SyntheticsDeleteTestsResponse SyntheticsDeletedTest SyntheticsDevice SyntheticsDeviceID SyntheticsErrorCode SyntheticsGetAPITestLatestResultsResponse SyntheticsGetBrowserTestLatestResultsResponse SyntheticsGlobalVariable SyntheticsGlobalVariableParseTestOptions SyntheticsGlobalVariableParseTestOptionsType SyntheticsGlobalVariableParserType SyntheticsGlobalVariableValue SyntheticsListTestsResponse SyntheticsLocation SyntheticsLocations SyntheticsParsingOptions SyntheticsPlayingTab SyntheticsPrivateLocation SyntheticsPrivateLocationCreationResponse SyntheticsPrivateLocationCreationResponseResultEncryption SyntheticsPrivateLocationSecrets SyntheticsPrivateLocationSecretsAuthentication SyntheticsPrivateLocationSecretsConfigDecryption SyntheticsSSLCertificate SyntheticsSSLCertificateIssuer SyntheticsSSLCertificateSubject SyntheticsStep SyntheticsStepDetail SyntheticsStepDetailWarning SyntheticsStepType SyntheticsTestConfig SyntheticsTestDetails SyntheticsTestDetailsSubType SyntheticsTestDetailsType SyntheticsTestHeaders SyntheticsTestMonitorStatus SyntheticsTestOptions SyntheticsTestOptionsMonitorOptions SyntheticsTestOptionsRetry SyntheticsTestPauseStatus SyntheticsTestProcessStatus SyntheticsTestRequest SyntheticsTestRequestCertificate SyntheticsTestRequestCertificateItem SyntheticsTickInterval SyntheticsTiming SyntheticsTriggerCITestLocation SyntheticsTriggerCITestRunResult SyntheticsTriggerCITestsResponse SyntheticsUpdateTestPauseStatusPayload SyntheticsVariableParser SyntheticsWarningType TableWidgetCellDisplayMode TableWidgetDefinition TableWidgetDefinitionType TableWidgetHasSearchBar TableWidgetRequest TagToHosts TargetFormatType TimeseriesWidgetDefinition TimeseriesWidgetDefinitionType TimeseriesWidgetExpressionAlias TimeseriesWidgetLegendColumn TimeseriesWidgetLegendLayout TimeseriesWidgetRequest ToplistWidgetDefinition ToplistWidgetDefinitionType ToplistWidgetRequest UsageAnalyzedLogsHour UsageAnalyzedLogsResponse UsageAttributionAggregates UsageAttributionAggregatesBody UsageAttributionBody UsageAttributionMetadata UsageAttributionPagination UsageAttributionResponse UsageAttributionSort UsageAttributionTagNames UsageAttributionValues UsageBillableSummaryBody UsageBillableSummaryHour UsageBillableSummaryKeys UsageBillableSummaryResponse UsageComplianceHour UsageComplianceResponse UsageCustomReportsAttributes UsageCustomReportsData UsageCustomReportsMeta UsageCustomReportsPage UsageCustomReportsResponse UsageFargateHour UsageFargateResponse UsageHostHour UsageHostsResponse UsageIncidentManagementHour UsageIncidentManagementResponse UsageIndexedSpansHour UsageIndexedSpansResponse UsageIngestedSpansHour UsageIngestedSpansResponse UsageIoTHour UsageIoTResponse UsageLambdaHour UsageLambdaResponse UsageLogsByIndexHour UsageLogsByIndexResponse UsageLogsByRetentionHour UsageLogsByRetentionResponse UsageLogsHour UsageLogsResponse UsageMetricCategory UsageNetworkFlowsHour UsageNetworkFlowsResponse UsageNetworkHostsHour UsageNetworkHostsResponse UsageProfilingHour UsageProfilingResponse UsageReportsType UsageRumSessionsHour UsageRumSessionsResponse UsageSNMPHour UsageSNMPResponse UsageSort UsageSortDirection UsageSpecifiedCustomReportsAttributes UsageSpecifiedCustomReportsData UsageSpecifiedCustomReportsMeta UsageSpecifiedCustomReportsPage UsageSpecifiedCustomReportsResponse UsageSummaryDate UsageSummaryDateOrg UsageSummaryResponse UsageSyntheticsAPIHour UsageSyntheticsAPIResponse UsageSyntheticsBrowserHour UsageSyntheticsBrowserResponse UsageSyntheticsHour UsageSyntheticsResponse UsageTimeseriesHour UsageTimeseriesResponse UsageTopAvgMetricsHour UsageTopAvgMetricsMetadata UsageTopAvgMetricsResponse UsageTraceHour UsageTraceResponse UsageTracingWithoutLimitsHour UsageTracingWithoutLimitsResponse User UserDisableResponse UserListResponse UserResponse Widget WidgetAggregator WidgetAxis WidgetChangeType WidgetColorPreference WidgetComparator WidgetCompareTo WidgetConditionalFormat WidgetCustomLink WidgetDefinition WidgetDisplayType WidgetEvent WidgetEventSize WidgetFieldSort WidgetFormula WidgetFormulaLimit WidgetGrouping WidgetHorizontalAlign WidgetImageSizing WidgetLayout WidgetLayoutType WidgetLineType WidgetLineWidth WidgetLiveSpan WidgetMargin WidgetMarker WidgetMessageDisplay WidgetMonitorSummaryDisplayFormat WidgetMonitorSummarySort WidgetNodeType WidgetOrderBy WidgetPalette WidgetRequestStyle WidgetServiceSummaryDisplayFormat WidgetSizeFormat WidgetSort WidgetStyle WidgetSummaryType WidgetTextAlign WidgetTickEdge WidgetTime WidgetTimeWindows WidgetVerticalAlign WidgetViewMode WidgetVizType","title":"Documentation For Models"},{"location":"v1/#documentation-for-authorization","text":"","title":"Documentation For Authorization"},{"location":"v1/#apikeyauth","text":"Type : API key API key parameter name : DD-API-KEY Location : HTTP header","title":"apiKeyAuth"},{"location":"v1/#apikeyauthquery","text":"Type : API key API key parameter name : api_key Location : URL query string","title":"apiKeyAuthQuery"},{"location":"v1/#appkeyauth","text":"Type : API key API key parameter name : DD-APPLICATION-KEY Location : HTTP header","title":"appKeyAuth"},{"location":"v1/#appkeyauthquery","text":"Type : API key API key parameter name : application_key Location : URL query string","title":"appKeyAuthQuery"},{"location":"v1/#author","text":"support@datadoghq.com","title":"Author"},{"location":"v1/#notes-for-large-openapi-documents","text":"If the OpenAPI document is large, imports in datadog_api_client.v1.apis and datadog_api_client.v1.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v1.api.default_api import DefaultApi - from datadog_api_client.v1.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v1 from datadog_api_client.v1.apis import * from datadog_api_client.v1.models import *","title":"Notes for Large OpenAPI documents"},{"location":"v1/APIErrorResponse/","text":"APIErrorResponse Error response object. Properties Name Type Description Notes errors [str] Array of errors returned by the API. [Back to Model list] [Back to API list] [Back to README]","title":"APIErrorResponse"},{"location":"v1/APIErrorResponse/#apierrorresponse","text":"Error response object.","title":"APIErrorResponse"},{"location":"v1/APIErrorResponse/#properties","text":"Name Type Description Notes errors [str] Array of errors returned by the API. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccount/","text":"AWSAccount Returns the AWS account associated with this integration. Properties Name Type Description Notes access_key_id str Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. [optional] account_id str Your AWS Account ID without dashes. [optional] account_specific_namespace_rules {str: (bool,)} 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] excluded_regions [str] An array of AWS regions to exclude from metrics collection. [optional] filter_tags [str] 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 [str] Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. [optional] role_name str Your Datadog role delegation name. [optional] secret_access_key str Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccount"},{"location":"v1/AWSAccount/#awsaccount","text":"Returns the AWS account associated with this integration.","title":"AWSAccount"},{"location":"v1/AWSAccount/#properties","text":"Name Type Description Notes access_key_id str Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. [optional] account_id str Your AWS Account ID without dashes. [optional] account_specific_namespace_rules {str: (bool,)} 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] excluded_regions [str] An array of AWS regions to exclude from metrics collection. [optional] filter_tags [str] 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 [str] Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. [optional] role_name str Your Datadog role delegation name. [optional] secret_access_key str Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccountAndLambdaRequest/","text":"AWSAccountAndLambdaRequest AWS account ID and Lambda ARN. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. lambda_arn str ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccountAndLambdaRequest"},{"location":"v1/AWSAccountAndLambdaRequest/#awsaccountandlambdarequest","text":"AWS account ID and Lambda ARN.","title":"AWSAccountAndLambdaRequest"},{"location":"v1/AWSAccountAndLambdaRequest/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. lambda_arn str ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccountCreateResponse/","text":"AWSAccountCreateResponse The Response returned by the AWS Create Account call. Properties Name Type Description Notes external_id str AWS external_id. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccountCreateResponse"},{"location":"v1/AWSAccountCreateResponse/#awsaccountcreateresponse","text":"The Response returned by the AWS Create Account call.","title":"AWSAccountCreateResponse"},{"location":"v1/AWSAccountCreateResponse/#properties","text":"Name Type Description Notes external_id str AWS external_id. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccountListResponse/","text":"AWSAccountListResponse List of enabled AWS accounts. Properties Name Type Description Notes accounts [AWSAccount] List of enabled AWS accounts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccountListResponse"},{"location":"v1/AWSAccountListResponse/#awsaccountlistresponse","text":"List of enabled AWS accounts.","title":"AWSAccountListResponse"},{"location":"v1/AWSAccountListResponse/#properties","text":"Name Type Description Notes accounts [AWSAccount] List of enabled AWS accounts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSIntegrationApi/","text":"datadog_api_client.v1.AWSIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_aws_account POST /api/v1/integration/aws Create an AWS integration create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules list_aws_accounts GET /api/v1/integration/aws List all AWS integrations list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters update_aws_account PUT /api/v1/integration/aws Update an AWS integration create_aws_account AWSAccountCreateResponse create_aws_account(body) Create an AWS integration Create a Datadog-Amazon Web Services integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount AWS Request Object Return type AWSAccountCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_aws_tag_filter {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_tag_filter(body) Set an AWS tag filter Set an AWS tag filter. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterCreateRequest( account_id=\"1234567\", namespace=AWSNamespace(\"elb\"), tag_filter_str=\"prod*\", ) # AWSTagFilterCreateRequest | 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`. # example passing only required values which don't have defaults set try: # Set an AWS tag filter api_response = api_instance.create_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_tag_filter: %s\\n\" % e) Parameters Name Type Description Notes body AWSTagFilterCreateRequest 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 {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_new_aws_external_id AWSAccountCreateResponse create_new_aws_external_id(body) Generate a new external ID Generate a new AWS external ID for a given AWS account ID and role name pair. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://github.com/DataDog/documentation/blob/master/integrations/amazon_web_services/#installation). # example passing only required values which don't have defaults set try: # Generate a new external ID api_response = api_instance.create_new_aws_external_id(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_new_aws_external_id: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount Your Datadog role delegation name. For more information about your AWS account Role name, see the Datadog AWS integration configuration info . Return type AWSAccountCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_aws_account {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_account(body) Delete an AWS integration Delete a Datadog-AWS integration matching the specified account_id and role_name parameters . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object # example passing only required values which don't have defaults set try: # Delete an AWS integration api_response = api_instance.delete_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_account: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount AWS request object Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_aws_tag_filter {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_tag_filter(body) Delete a tag filtering entry Delete a tag filtering entry. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterDeleteRequest( account_id=\"FAKEAC0FAKEAC2FAKEAC\", namespace=AWSNamespace(\"elb\"), ) # AWSTagFilterDeleteRequest | Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. # example passing only required values which don't have defaults set try: # Delete a tag filtering entry api_response = api_instance.delete_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_tag_filter: %s\\n\" % e) Parameters Name Type Description Notes body AWSTagFilterDeleteRequest Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_available_aws_namespaces [str] list_available_aws_namespaces() List namespace rules List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List namespace rules api_response = api_instance.list_available_aws_namespaces() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_available_aws_namespaces: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type [str] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_accounts AWSAccountListResponse list_aws_accounts() List all AWS integrations List all Datadog-AWS integrations available in your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that matches this role_name. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all AWS integrations api_response = api_instance.list_aws_accounts(account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_accounts: %s\\n\" % e) Parameters Name Type Description Notes account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that matches this role_name. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. [optional] Return type AWSAccountListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_tag_filters AWSTagFilterListResponse list_aws_tag_filters(account_id) Get all AWS tag filters Get all AWS tag filters. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS filters that matches this `account_id`. # example passing only required values which don't have defaults set try: # Get all AWS tag filters api_response = api_instance.list_aws_tag_filters(account_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_tag_filters: %s\\n\" % e) Parameters Name Type Description Notes account_id str Only return AWS filters that matches this `account_id`. Return type AWSTagFilterListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_aws_account {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_aws_account(body) Update an AWS integration Update a Datadog-Amazon Web Services integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. (optional) # example passing only required values which don't have defaults set try: # Update an AWS integration api_response = api_instance.update_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update an AWS integration api_response = api_instance.update_aws_account(body, account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount AWS request object account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. [optional] Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AWSIntegrationApi"},{"location":"v1/AWSIntegrationApi/#datadog_api_clientv1awsintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_aws_account POST /api/v1/integration/aws Create an AWS integration create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules list_aws_accounts GET /api/v1/integration/aws List all AWS integrations list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters update_aws_account PUT /api/v1/integration/aws Update an AWS integration","title":"datadog_api_client.v1.AWSIntegrationApi"},{"location":"v1/AWSIntegrationApi/#create_aws_account","text":"AWSAccountCreateResponse create_aws_account(body) Create an AWS integration Create a Datadog-Amazon Web Services integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication.","title":"create_aws_account"},{"location":"v1/AWSIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters","text":"Name Type Description Notes body AWSAccount AWS Request Object","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type","text":"AWSAccountCreateResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#create_aws_tag_filter","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_tag_filter(body) Set an AWS tag filter Set an AWS tag filter.","title":"create_aws_tag_filter"},{"location":"v1/AWSIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterCreateRequest( account_id=\"1234567\", namespace=AWSNamespace(\"elb\"), tag_filter_str=\"prod*\", ) # AWSTagFilterCreateRequest | 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`. # example passing only required values which don't have defaults set try: # Set an AWS tag filter api_response = api_instance.create_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_tag_filter: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_1","text":"Name Type Description Notes body AWSTagFilterCreateRequest 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`.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#create_new_aws_external_id","text":"AWSAccountCreateResponse create_new_aws_external_id(body) Generate a new external ID Generate a new AWS external ID for a given AWS account ID and role name pair.","title":"create_new_aws_external_id"},{"location":"v1/AWSIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://github.com/DataDog/documentation/blob/master/integrations/amazon_web_services/#installation). # example passing only required values which don't have defaults set try: # Generate a new external ID api_response = api_instance.create_new_aws_external_id(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_new_aws_external_id: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_2","text":"Name Type Description Notes body AWSAccount Your Datadog role delegation name. For more information about your AWS account Role name, see the Datadog AWS integration configuration info .","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_2","text":"AWSAccountCreateResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#delete_aws_account","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_account(body) Delete an AWS integration Delete a Datadog-AWS integration matching the specified account_id and role_name parameters .","title":"delete_aws_account"},{"location":"v1/AWSIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object # example passing only required values which don't have defaults set try: # Delete an AWS integration api_response = api_instance.delete_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_account: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_3","text":"Name Type Description Notes body AWSAccount AWS request object","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#delete_aws_tag_filter","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_tag_filter(body) Delete a tag filtering entry Delete a tag filtering entry.","title":"delete_aws_tag_filter"},{"location":"v1/AWSIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterDeleteRequest( account_id=\"FAKEAC0FAKEAC2FAKEAC\", namespace=AWSNamespace(\"elb\"), ) # AWSTagFilterDeleteRequest | Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. # example passing only required values which don't have defaults set try: # Delete a tag filtering entry api_response = api_instance.delete_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_tag_filter: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_4","text":"Name Type Description Notes body AWSTagFilterDeleteRequest Delete a tag filtering entry for a given AWS account and `dd-aws` namespace.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_4","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#list_available_aws_namespaces","text":"[str] list_available_aws_namespaces() List namespace rules List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.","title":"list_available_aws_namespaces"},{"location":"v1/AWSIntegrationApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List namespace rules api_response = api_instance.list_available_aws_namespaces() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_available_aws_namespaces: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_5","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_5","text":"[str]","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#list_aws_accounts","text":"AWSAccountListResponse list_aws_accounts() List all AWS integrations List all Datadog-AWS integrations available in your Datadog organization.","title":"list_aws_accounts"},{"location":"v1/AWSIntegrationApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that matches this role_name. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all AWS integrations api_response = api_instance.list_aws_accounts(account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_accounts: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_6","text":"Name Type Description Notes account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that matches this role_name. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. [optional]","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_6","text":"AWSAccountListResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#list_aws_tag_filters","text":"AWSTagFilterListResponse list_aws_tag_filters(account_id) Get all AWS tag filters Get all AWS tag filters.","title":"list_aws_tag_filters"},{"location":"v1/AWSIntegrationApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS filters that matches this `account_id`. # example passing only required values which don't have defaults set try: # Get all AWS tag filters api_response = api_instance.list_aws_tag_filters(account_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_tag_filters: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_7","text":"Name Type Description Notes account_id str Only return AWS filters that matches this `account_id`.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_7","text":"AWSTagFilterListResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#update_aws_account","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_aws_account(body) Update an AWS integration Update a Datadog-Amazon Web Services integration.","title":"update_aws_account"},{"location":"v1/AWSIntegrationApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. (optional) # example passing only required values which don't have defaults set try: # Update an AWS integration api_response = api_instance.update_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update an AWS integration api_response = api_instance.update_aws_account(body, account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_8","text":"Name Type Description Notes body AWSAccount AWS request object account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. [optional]","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_8","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsAsyncError/","text":"AWSLogsAsyncError Description of errors. Properties Name Type Description Notes code str Code properties [optional] message str Message content. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsAsyncError"},{"location":"v1/AWSLogsAsyncError/#awslogsasyncerror","text":"Description of errors.","title":"AWSLogsAsyncError"},{"location":"v1/AWSLogsAsyncError/#properties","text":"Name Type Description Notes code str Code properties [optional] message str Message content. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsAsyncResponse/","text":"AWSLogsAsyncResponse A list of all Datadog-AWS logs integrations available in your Datadog organization. Properties Name Type Description Notes errors [AWSLogsAsyncError] List of errors. [optional] status str Status of the properties. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsAsyncResponse"},{"location":"v1/AWSLogsAsyncResponse/#awslogsasyncresponse","text":"A list of all Datadog-AWS logs integrations available in your Datadog organization.","title":"AWSLogsAsyncResponse"},{"location":"v1/AWSLogsAsyncResponse/#properties","text":"Name Type Description Notes errors [AWSLogsAsyncError] List of errors. [optional] status str Status of the properties. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsIntegrationApi/","text":"datadog_api_client.v1.AWSLogsIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description 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 POST /api/v1/integration/aws/logs/services_async Check permissions for log services create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services check_aws_logs_lambda_async AWSLogsAsyncResponse check_aws_logs_lambda_async(body) Check that an AWS Lambda Function exists Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking. - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Check AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Check that an AWS Lambda Function exists api_response = api_instance.check_aws_logs_lambda_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_lambda_async: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccountAndLambdaRequest Check AWS Log Lambda Async request body. Return type AWSLogsAsyncResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] check_aws_logs_services_async AWSLogsAsyncResponse check_aws_logs_services_async(body) Check permissions for log services Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for EnableAWSLogServices . Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes. - Returns a status of created when it's checking if the permissions exists in the AWS account. - Returns a status of waiting while checking. - Returns a status of checked and ok if the Lambda exists. - Returns a status of error if the Lambda does not exist. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Check AWS Logs Async Services request body. # example passing only required values which don't have defaults set try: # Check permissions for log services api_response = api_instance.check_aws_logs_services_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_services_async: %s\\n\" % e) Parameters Name Type Description Notes body AWSLogsServicesRequest Check AWS Logs Async Services request body. Return type AWSLogsAsyncResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_aws_lambda_arn {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_lambda_arn(body) Add AWS Log Lambda ARN Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Add AWS Log Lambda ARN api_response = api_instance.create_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->create_aws_lambda_arn: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccountAndLambdaRequest AWS Log Lambda Async request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_aws_lambda_arn {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_lambda_arn(body) Delete an AWS Logs integration Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Delete AWS Lambda ARN request body. # example passing only required values which don't have defaults set try: # Delete an AWS Logs integration api_response = api_instance.delete_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->delete_aws_lambda_arn: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccountAndLambdaRequest Delete AWS Lambda ARN request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] enable_aws_log_services {str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_aws_log_services(body) Enable an AWS Logs integration Enable automatic log collection for a list of services. This should be run after running CreateAWSLambdaARN to save the configuration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Enable AWS Log Services request body. # example passing only required values which don't have defaults set try: # Enable an AWS Logs integration api_response = api_instance.enable_aws_log_services(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->enable_aws_log_services: %s\\n\" % e) Parameters Name Type Description Notes body AWSLogsServicesRequest Enable AWS Log Services request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_logs_integrations [AWSLogsListResponse] list_aws_logs_integrations() List all AWS Logs integrations List all Datadog-AWS Logs integrations configured in your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all AWS Logs integrations api_response = api_instance.list_aws_logs_integrations() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_integrations: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type [AWSLogsListResponse] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_logs_services [AWSLogsListServicesResponse] list_aws_logs_services() Get list of AWS log ready services Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # Get list of AWS log ready services api_response = api_instance.list_aws_logs_services() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_services: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type [AWSLogsListServicesResponse] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AWSLogsIntegrationApi"},{"location":"v1/AWSLogsIntegrationApi/#datadog_api_clientv1awslogsintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description 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 POST /api/v1/integration/aws/logs/services_async Check permissions for log services create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services","title":"datadog_api_client.v1.AWSLogsIntegrationApi"},{"location":"v1/AWSLogsIntegrationApi/#check_aws_logs_lambda_async","text":"AWSLogsAsyncResponse check_aws_logs_lambda_async(body) Check that an AWS Lambda Function exists Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking. - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist.","title":"check_aws_logs_lambda_async"},{"location":"v1/AWSLogsIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Check AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Check that an AWS Lambda Function exists api_response = api_instance.check_aws_logs_lambda_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_lambda_async: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters","text":"Name Type Description Notes body AWSAccountAndLambdaRequest Check AWS Log Lambda Async request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type","text":"AWSLogsAsyncResponse","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#check_aws_logs_services_async","text":"AWSLogsAsyncResponse check_aws_logs_services_async(body) Check permissions for log services Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for EnableAWSLogServices . Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes. - Returns a status of created when it's checking if the permissions exists in the AWS account. - Returns a status of waiting while checking. - Returns a status of checked and ok if the Lambda exists. - Returns a status of error if the Lambda does not exist.","title":"check_aws_logs_services_async"},{"location":"v1/AWSLogsIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Check AWS Logs Async Services request body. # example passing only required values which don't have defaults set try: # Check permissions for log services api_response = api_instance.check_aws_logs_services_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_services_async: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_1","text":"Name Type Description Notes body AWSLogsServicesRequest Check AWS Logs Async Services request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_1","text":"AWSLogsAsyncResponse","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#create_aws_lambda_arn","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_lambda_arn(body) Add AWS Log Lambda ARN Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection.","title":"create_aws_lambda_arn"},{"location":"v1/AWSLogsIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Add AWS Log Lambda ARN api_response = api_instance.create_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->create_aws_lambda_arn: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_2","text":"Name Type Description Notes body AWSAccountAndLambdaRequest AWS Log Lambda Async request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_2","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#delete_aws_lambda_arn","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_lambda_arn(body) Delete an AWS Logs integration Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account.","title":"delete_aws_lambda_arn"},{"location":"v1/AWSLogsIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Delete AWS Lambda ARN request body. # example passing only required values which don't have defaults set try: # Delete an AWS Logs integration api_response = api_instance.delete_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->delete_aws_lambda_arn: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_3","text":"Name Type Description Notes body AWSAccountAndLambdaRequest Delete AWS Lambda ARN request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#enable_aws_log_services","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_aws_log_services(body) Enable an AWS Logs integration Enable automatic log collection for a list of services. This should be run after running CreateAWSLambdaARN to save the configuration.","title":"enable_aws_log_services"},{"location":"v1/AWSLogsIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Enable AWS Log Services request body. # example passing only required values which don't have defaults set try: # Enable an AWS Logs integration api_response = api_instance.enable_aws_log_services(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->enable_aws_log_services: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_4","text":"Name Type Description Notes body AWSLogsServicesRequest Enable AWS Log Services request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_4","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#list_aws_logs_integrations","text":"[AWSLogsListResponse] list_aws_logs_integrations() List all AWS Logs integrations List all Datadog-AWS Logs integrations configured in your Datadog account.","title":"list_aws_logs_integrations"},{"location":"v1/AWSLogsIntegrationApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all AWS Logs integrations api_response = api_instance.list_aws_logs_integrations() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_integrations: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_5","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_5","text":"[AWSLogsListResponse]","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#list_aws_logs_services","text":"[AWSLogsListServicesResponse] list_aws_logs_services() Get list of AWS log ready services Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.","title":"list_aws_logs_services"},{"location":"v1/AWSLogsIntegrationApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # Get list of AWS log ready services api_response = api_instance.list_aws_logs_services() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_services: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_6","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_6","text":"[AWSLogsListServicesResponse]","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsLambda/","text":"AWSLogsLambda Description of the Lambdas. Properties Name Type Description Notes arn str Available ARN IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsLambda"},{"location":"v1/AWSLogsLambda/#awslogslambda","text":"Description of the Lambdas.","title":"AWSLogsLambda"},{"location":"v1/AWSLogsLambda/#properties","text":"Name Type Description Notes arn str Available ARN IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsListResponse/","text":"AWSLogsListResponse A list of all Datadog-AWS logs integrations available in your Datadog organization. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] lambdas [AWSLogsLambda] List of ARNs configured in your Datadog account. [optional] services [str] Array of services IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsListResponse"},{"location":"v1/AWSLogsListResponse/#awslogslistresponse","text":"A list of all Datadog-AWS logs integrations available in your Datadog organization.","title":"AWSLogsListResponse"},{"location":"v1/AWSLogsListResponse/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] lambdas [AWSLogsLambda] List of ARNs configured in your Datadog account. [optional] services [str] Array of services IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsListServicesResponse/","text":"AWSLogsListServicesResponse The list of current AWS services for which Datadog offers automatic log collection. Properties Name Type Description Notes id str Key value in returned object. [optional] label str Name of service available for configuration with Datadog logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsListServicesResponse"},{"location":"v1/AWSLogsListServicesResponse/#awslogslistservicesresponse","text":"The list of current AWS services for which Datadog offers automatic log collection.","title":"AWSLogsListServicesResponse"},{"location":"v1/AWSLogsListServicesResponse/#properties","text":"Name Type Description Notes id str Key value in returned object. [optional] label str Name of service available for configuration with Datadog logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsServicesRequest/","text":"AWSLogsServicesRequest A list of current AWS services for which Datadog offers automatic log collection. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. services [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsServicesRequest"},{"location":"v1/AWSLogsServicesRequest/#awslogsservicesrequest","text":"A list of current AWS services for which Datadog offers automatic log collection.","title":"AWSLogsServicesRequest"},{"location":"v1/AWSLogsServicesRequest/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. services [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSNamespace/","text":"AWSNamespace The namespace associated with the tag filter entry. Properties Name Type Description Notes value str The namespace associated with the tag filter entry. must be one of [\"elb\", \"application_elb\", \"sqs\", \"rds\", \"custom\", \"network_elb\", \"lambda\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AWSNamespace"},{"location":"v1/AWSNamespace/#awsnamespace","text":"The namespace associated with the tag filter entry.","title":"AWSNamespace"},{"location":"v1/AWSNamespace/#properties","text":"Name Type Description Notes value str The namespace associated with the tag filter entry. must be one of [\"elb\", \"application_elb\", \"sqs\", \"rds\", \"custom\", \"network_elb\", \"lambda\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilter/","text":"AWSTagFilter A tag filter. Properties Name Type Description Notes namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilter"},{"location":"v1/AWSTagFilter/#awstagfilter","text":"A tag filter.","title":"AWSTagFilter"},{"location":"v1/AWSTagFilter/#properties","text":"Name Type Description Notes namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilterCreateRequest/","text":"AWSTagFilterCreateRequest The objects used to set an AWS tag filter. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilterCreateRequest"},{"location":"v1/AWSTagFilterCreateRequest/#awstagfiltercreaterequest","text":"The objects used to set an AWS tag filter.","title":"AWSTagFilterCreateRequest"},{"location":"v1/AWSTagFilterCreateRequest/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilterDeleteRequest/","text":"AWSTagFilterDeleteRequest The objects used to delete an AWS tag filter entry. Properties Name Type Description Notes account_id str The unique identifier of your AWS account. [optional] namespace AWSNamespace [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilterDeleteRequest"},{"location":"v1/AWSTagFilterDeleteRequest/#awstagfilterdeleterequest","text":"The objects used to delete an AWS tag filter entry.","title":"AWSTagFilterDeleteRequest"},{"location":"v1/AWSTagFilterDeleteRequest/#properties","text":"Name Type Description Notes account_id str The unique identifier of your AWS account. [optional] namespace AWSNamespace [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilterListResponse/","text":"AWSTagFilterListResponse An array of tag filter rules by namespace and tag filter string. Properties Name Type Description Notes filters [AWSTagFilter] An array of tag filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilterListResponse"},{"location":"v1/AWSTagFilterListResponse/#awstagfilterlistresponse","text":"An array of tag filter rules by namespace and tag filter string.","title":"AWSTagFilterListResponse"},{"location":"v1/AWSTagFilterListResponse/#properties","text":"Name Type Description Notes filters [AWSTagFilter] An array of tag filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AccessRole/","text":"AccessRole The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). Properties Name Type Description Notes value str The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). defaults to \"st\", must be one of [\"st\", \"adm\", \"ro\", \"ERROR\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AccessRole"},{"location":"v1/AccessRole/#accessrole","text":"The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).","title":"AccessRole"},{"location":"v1/AccessRole/#properties","text":"Name Type Description Notes value str The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). defaults to \"st\", must be one of [\"st\", \"adm\", \"ro\", \"ERROR\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertGraphWidgetDefinition/","text":"AlertGraphWidgetDefinition Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. Properties Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertGraphWidgetDefinitionType viz_type WidgetVizType time WidgetTime [optional] title str The title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AlertGraphWidgetDefinition"},{"location":"v1/AlertGraphWidgetDefinition/#alertgraphwidgetdefinition","text":"Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.","title":"AlertGraphWidgetDefinition"},{"location":"v1/AlertGraphWidgetDefinition/#properties","text":"Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertGraphWidgetDefinitionType viz_type WidgetVizType time WidgetTime [optional] title str The title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertGraphWidgetDefinitionType/","text":"AlertGraphWidgetDefinitionType Type of the alert graph widget. Properties Name Type Description Notes value str Type of the alert graph widget. defaults to \"alert_graph\", must be one of [\"alert_graph\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AlertGraphWidgetDefinitionType"},{"location":"v1/AlertGraphWidgetDefinitionType/#alertgraphwidgetdefinitiontype","text":"Type of the alert graph widget.","title":"AlertGraphWidgetDefinitionType"},{"location":"v1/AlertGraphWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the alert graph widget. defaults to \"alert_graph\", must be one of [\"alert_graph\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertValueWidgetDefinition/","text":"AlertValueWidgetDefinition Alert values are query values showing the current value of the metric in any monitor defined on your system. Properties Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertValueWidgetDefinitionType precision int Number of decimal to show. If not defined, will use the raw value. [optional] text_align WidgetTextAlign [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of value in the widget. [optional] unit str Unit to display with the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AlertValueWidgetDefinition"},{"location":"v1/AlertValueWidgetDefinition/#alertvaluewidgetdefinition","text":"Alert values are query values showing the current value of the metric in any monitor defined on your system.","title":"AlertValueWidgetDefinition"},{"location":"v1/AlertValueWidgetDefinition/#properties","text":"Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertValueWidgetDefinitionType precision int Number of decimal to show. If not defined, will use the raw value. [optional] text_align WidgetTextAlign [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of value in the widget. [optional] unit str Unit to display with the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertValueWidgetDefinitionType/","text":"AlertValueWidgetDefinitionType Type of the alert value widget. Properties Name Type Description Notes value str Type of the alert value widget. defaults to \"alert_value\", must be one of [\"alert_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AlertValueWidgetDefinitionType"},{"location":"v1/AlertValueWidgetDefinitionType/#alertvaluewidgetdefinitiontype","text":"Type of the alert value widget.","title":"AlertValueWidgetDefinitionType"},{"location":"v1/AlertValueWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the alert value widget. defaults to \"alert_value\", must be one of [\"alert_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApiKey/","text":"ApiKey Datadog API key. Properties Name Type Description Notes created str Date of creation of the API key. optional created_by str Datadog user handle that created the API key. optional key str API key. optional name str Name of your API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApiKey"},{"location":"v1/ApiKey/#apikey","text":"Datadog API key.","title":"ApiKey"},{"location":"v1/ApiKey/#properties","text":"Name Type Description Notes created str Date of creation of the API key. optional created_by str Datadog user handle that created the API key. optional key str API key. optional name str Name of your API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApiKeyListResponse/","text":"ApiKeyListResponse List of API and application keys available for a given organization. Properties Name Type Description Notes api_keys [ApiKey] Array of API keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApiKeyListResponse"},{"location":"v1/ApiKeyListResponse/#apikeylistresponse","text":"List of API and application keys available for a given organization.","title":"ApiKeyListResponse"},{"location":"v1/ApiKeyListResponse/#properties","text":"Name Type Description Notes api_keys [ApiKey] Array of API keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApiKeyResponse/","text":"ApiKeyResponse An API key with its associated metadata. Properties Name Type Description Notes api_key ApiKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApiKeyResponse"},{"location":"v1/ApiKeyResponse/#apikeyresponse","text":"An API key with its associated metadata.","title":"ApiKeyResponse"},{"location":"v1/ApiKeyResponse/#properties","text":"Name Type Description Notes api_key ApiKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApmStatsQueryColumnType/","text":"ApmStatsQueryColumnType Column properties. Properties Name Type Description Notes name str Column name. alias str A user-assigned alias for the column. [optional] cell_display_mode TableWidgetCellDisplayMode [optional] order WidgetSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApmStatsQueryColumnType"},{"location":"v1/ApmStatsQueryColumnType/#apmstatsquerycolumntype","text":"Column properties.","title":"ApmStatsQueryColumnType"},{"location":"v1/ApmStatsQueryColumnType/#properties","text":"Name Type Description Notes name str Column name. alias str A user-assigned alias for the column. [optional] cell_display_mode TableWidgetCellDisplayMode [optional] order WidgetSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApmStatsQueryDefinition/","text":"ApmStatsQueryDefinition The APM stats query for table and distributions widgets. Properties Name Type Description Notes env str Environment name. name str Operation name associated with service. primary_tag str The organization's host group name and value. row_type ApmStatsQueryRowType service str Service name. columns [ApmStatsQueryColumnType] Column properties used by the front end for display. [optional] resource str Resource name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApmStatsQueryDefinition"},{"location":"v1/ApmStatsQueryDefinition/#apmstatsquerydefinition","text":"The APM stats query for table and distributions widgets.","title":"ApmStatsQueryDefinition"},{"location":"v1/ApmStatsQueryDefinition/#properties","text":"Name Type Description Notes env str Environment name. name str Operation name associated with service. primary_tag str The organization's host group name and value. row_type ApmStatsQueryRowType service str Service name. columns [ApmStatsQueryColumnType] Column properties used by the front end for display. [optional] resource str Resource name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApmStatsQueryRowType/","text":"ApmStatsQueryRowType The level of detail for the request. Properties Name Type Description Notes value str The level of detail for the request. must be one of [\"service\", \"resource\", \"span\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ApmStatsQueryRowType"},{"location":"v1/ApmStatsQueryRowType/#apmstatsqueryrowtype","text":"The level of detail for the request.","title":"ApmStatsQueryRowType"},{"location":"v1/ApmStatsQueryRowType/#properties","text":"Name Type Description Notes value str The level of detail for the request. must be one of [\"service\", \"resource\", \"span\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApplicationKey/","text":"ApplicationKey An application key with its associated metadata. Properties Name Type Description Notes hash str Hash of an application key. optional name str Name of an application key. [optional] owner str Owner of an application key. optional [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKey"},{"location":"v1/ApplicationKey/#applicationkey","text":"An application key with its associated metadata.","title":"ApplicationKey"},{"location":"v1/ApplicationKey/#properties","text":"Name Type Description Notes hash str Hash of an application key. optional name str Name of an application key. [optional] owner str Owner of an application key. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApplicationKeyListResponse/","text":"ApplicationKeyListResponse An application key response. Properties Name Type Description Notes application_keys [ApplicationKey] Array of application keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyListResponse"},{"location":"v1/ApplicationKeyListResponse/#applicationkeylistresponse","text":"An application key response.","title":"ApplicationKeyListResponse"},{"location":"v1/ApplicationKeyListResponse/#properties","text":"Name Type Description Notes application_keys [ApplicationKey] Array of application keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApplicationKeyResponse/","text":"ApplicationKeyResponse An application key response. Properties Name Type Description Notes application_key ApplicationKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyResponse"},{"location":"v1/ApplicationKeyResponse/#applicationkeyresponse","text":"An application key response.","title":"ApplicationKeyResponse"},{"location":"v1/ApplicationKeyResponse/#properties","text":"Name Type Description Notes application_key ApplicationKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AuthenticationApi/","text":"datadog_api_client.v1.AuthenticationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description validate GET /api/v1/validate Validate API key validate AuthenticationValidationResponse validate() Validate API key Check if the API key (not the APP key) is valid. If invalid, a 403 is returned. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import authentication_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = authentication_api.AuthenticationApi(api_client) # example, this endpoint has no required or optional parameters try: # Validate API key api_response = api_instance.validate() pprint(api_response) except ApiException as e: print(\"Exception when calling AuthenticationApi->validate: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type AuthenticationValidationResponse Authorization apiKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AuthenticationApi"},{"location":"v1/AuthenticationApi/#datadog_api_clientv1authenticationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description validate GET /api/v1/validate Validate API key","title":"datadog_api_client.v1.AuthenticationApi"},{"location":"v1/AuthenticationApi/#validate","text":"AuthenticationValidationResponse validate() Validate API key Check if the API key (not the APP key) is valid. If invalid, a 403 is returned.","title":"validate"},{"location":"v1/AuthenticationApi/#example","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import authentication_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = authentication_api.AuthenticationApi(api_client) # example, this endpoint has no required or optional parameters try: # Validate API key api_response = api_instance.validate() pprint(api_response) except ApiException as e: print(\"Exception when calling AuthenticationApi->validate: %s\\n\" % e)","title":"Example"},{"location":"v1/AuthenticationApi/#parameters","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AuthenticationApi/#return-type","text":"AuthenticationValidationResponse","title":"Return type"},{"location":"v1/AuthenticationApi/#authorization","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/AuthenticationApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AuthenticationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AuthenticationValidationResponse/","text":"AuthenticationValidationResponse Represent validation endpoint responses. Properties Name Type Description Notes valid bool Return `true` if the authentication response is valid. optional [Back to Model list] [Back to API list] [Back to README]","title":"AuthenticationValidationResponse"},{"location":"v1/AuthenticationValidationResponse/#authenticationvalidationresponse","text":"Represent validation endpoint responses.","title":"AuthenticationValidationResponse"},{"location":"v1/AuthenticationValidationResponse/#properties","text":"Name Type Description Notes valid bool Return `true` if the authentication response is valid. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AzureAccount/","text":"AzureAccount Datadog-Azure integrations configured for your organization. Properties Name Type Description Notes client_id str Your Azure web application ID. [optional] client_secret str Your Azure web application secret key. [optional] errors [str] Errors in your configuration. [optional] host_filters str 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 str Your New Azure web application ID. [optional] new_tenant_name str Your New Azure Active Directory ID. [optional] tenant_name str Your Azure Active Directory ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AzureAccount"},{"location":"v1/AzureAccount/#azureaccount","text":"Datadog-Azure integrations configured for your organization.","title":"AzureAccount"},{"location":"v1/AzureAccount/#properties","text":"Name Type Description Notes client_id str Your Azure web application ID. [optional] client_secret str Your Azure web application secret key. [optional] errors [str] Errors in your configuration. [optional] host_filters str 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 str Your New Azure web application ID. [optional] new_tenant_name str Your New Azure Active Directory ID. [optional] tenant_name str Your Azure Active Directory ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AzureAccountListResponse/","text":"AzureAccountListResponse Accounts configured for your organization. Properties Name Type Description Notes value [AzureAccount] Accounts configured for your organization. [Back to Model list] [Back to API list] [Back to README]","title":"AzureAccountListResponse"},{"location":"v1/AzureAccountListResponse/#azureaccountlistresponse","text":"Accounts configured for your organization.","title":"AzureAccountListResponse"},{"location":"v1/AzureAccountListResponse/#properties","text":"Name Type Description Notes value [AzureAccount] Accounts configured for your organization. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AzureIntegrationApi/","text":"datadog_api_client.v1.AzureIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_azure_integration POST /api/v1/integration/azure Create an Azure integration delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration list_azure_integration GET /api/v1/integration/azure List all Azure integrations update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters update_azure_integration PUT /api/v1/integration/azure Update an Azure integration create_azure_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_azure_integration(body) Create an Azure integration Create a Datadog-Azure integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. Using the PUT method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Create a Datadog-Azure integration for your Datadog account request body. # example passing only required values which don't have defaults set try: # Create an Azure integration api_response = api_instance.create_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->create_azure_integration: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Create a Datadog-Azure integration for your Datadog account request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_azure_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_azure_integration(body) Delete an Azure integration Delete a given Datadog-Azure integration from your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Delete a given Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Delete an Azure integration api_response = api_instance.delete_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->delete_azure_integration: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Delete a given Datadog-Azure integration request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_azure_integration AzureAccountListResponse list_azure_integration() List all Azure integrations List all Datadog-Azure integrations configured in your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all Azure integrations api_response = api_instance.list_azure_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->list_azure_integration: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type AzureAccountListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_azure_host_filters {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_host_filters(body) Update Azure integration host filters Update the defined list of host filters for a given Datadog-Azure integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration's host filters request body. # example passing only required values which don't have defaults set try: # Update Azure integration host filters api_response = api_instance.update_azure_host_filters(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_host_filters: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Update a Datadog-Azure integration's host filters request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_azure_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_integration(body) Update an Azure integration Update a Datadog-Azure integration. Requires an existing tenant_name and client_id . Any other fields supplied will overwrite existing values. To overwrite tenant_name or client_id , use new_tenant_name and new_client_id . To leave a field unchanged, do not supply that field in the payload. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Update an Azure integration api_response = api_instance.update_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_integration: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Update a Datadog-Azure integration request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AzureIntegrationApi"},{"location":"v1/AzureIntegrationApi/#datadog_api_clientv1azureintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_azure_integration POST /api/v1/integration/azure Create an Azure integration delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration list_azure_integration GET /api/v1/integration/azure List all Azure integrations update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters update_azure_integration PUT /api/v1/integration/azure Update an Azure integration","title":"datadog_api_client.v1.AzureIntegrationApi"},{"location":"v1/AzureIntegrationApi/#create_azure_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_azure_integration(body) Create an Azure integration Create a Datadog-Azure integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. Using the PUT method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"create_azure_integration"},{"location":"v1/AzureIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Create a Datadog-Azure integration for your Datadog account request body. # example passing only required values which don't have defaults set try: # Create an Azure integration api_response = api_instance.create_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->create_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters","text":"Name Type Description Notes body AzureAccount Create a Datadog-Azure integration for your Datadog account request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#delete_azure_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_azure_integration(body) Delete an Azure integration Delete a given Datadog-Azure integration from your Datadog account.","title":"delete_azure_integration"},{"location":"v1/AzureIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Delete a given Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Delete an Azure integration api_response = api_instance.delete_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->delete_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_1","text":"Name Type Description Notes body AzureAccount Delete a given Datadog-Azure integration request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#list_azure_integration","text":"AzureAccountListResponse list_azure_integration() List all Azure integrations List all Datadog-Azure integrations configured in your Datadog account.","title":"list_azure_integration"},{"location":"v1/AzureIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all Azure integrations api_response = api_instance.list_azure_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->list_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_2","text":"AzureAccountListResponse","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#update_azure_host_filters","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_host_filters(body) Update Azure integration host filters Update the defined list of host filters for a given Datadog-Azure integration.","title":"update_azure_host_filters"},{"location":"v1/AzureIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration's host filters request body. # example passing only required values which don't have defaults set try: # Update Azure integration host filters api_response = api_instance.update_azure_host_filters(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_host_filters: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_3","text":"Name Type Description Notes body AzureAccount Update a Datadog-Azure integration's host filters request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#update_azure_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_integration(body) Update an Azure integration Update a Datadog-Azure integration. Requires an existing tenant_name and client_id . Any other fields supplied will overwrite existing values. To overwrite tenant_name or client_id , use new_tenant_name and new_client_id . To leave a field unchanged, do not supply that field in the payload.","title":"update_azure_integration"},{"location":"v1/AzureIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Update an Azure integration api_response = api_instance.update_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_4","text":"Name Type Description Notes body AzureAccount Update a Datadog-Azure integration request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_4","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/CancelDowntimesByScopeRequest/","text":"CancelDowntimesByScopeRequest Cancel downtimes according to scope. Properties Name Type Description Notes scope str 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`). [Back to Model list] [Back to API list] [Back to README]","title":"CancelDowntimesByScopeRequest"},{"location":"v1/CancelDowntimesByScopeRequest/#canceldowntimesbyscoperequest","text":"Cancel downtimes according to scope.","title":"CancelDowntimesByScopeRequest"},{"location":"v1/CancelDowntimesByScopeRequest/#properties","text":"Name Type Description Notes scope str 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`). [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CanceledDowntimesIds/","text":"CanceledDowntimesIds Object containing array of IDs of canceled downtimes. Properties Name Type Description Notes cancelled_ids [int] ID of downtimes that were canceled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CanceledDowntimesIds"},{"location":"v1/CanceledDowntimesIds/#canceleddowntimesids","text":"Object containing array of IDs of canceled downtimes.","title":"CanceledDowntimesIds"},{"location":"v1/CanceledDowntimesIds/#properties","text":"Name Type Description Notes cancelled_ids [int] ID of downtimes that were canceled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ChangeWidgetDefinition/","text":"ChangeWidgetDefinition The Change graph shows you the change in a value over the time period chosen. Properties Name Type Description Notes requests [ChangeWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type ChangeWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ChangeWidgetDefinition"},{"location":"v1/ChangeWidgetDefinition/#changewidgetdefinition","text":"The Change graph shows you the change in a value over the time period chosen.","title":"ChangeWidgetDefinition"},{"location":"v1/ChangeWidgetDefinition/#properties","text":"Name Type Description Notes requests [ChangeWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type ChangeWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ChangeWidgetDefinitionType/","text":"ChangeWidgetDefinitionType Type of the change widget. Properties Name Type Description Notes value str Type of the change widget. defaults to \"change\", must be one of [\"change\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ChangeWidgetDefinitionType"},{"location":"v1/ChangeWidgetDefinitionType/#changewidgetdefinitiontype","text":"Type of the change widget.","title":"ChangeWidgetDefinitionType"},{"location":"v1/ChangeWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the change widget. defaults to \"change\", must be one of [\"change\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ChangeWidgetRequest/","text":"ChangeWidgetRequest Updated change widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] change_type WidgetChangeType [optional] compare_to WidgetCompareTo [optional] event_query LogQueryDefinition [optional] increase_good bool Whether to show increase as good. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order_by WidgetOrderBy [optional] order_dir WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] show_present bool Whether to show the present value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ChangeWidgetRequest"},{"location":"v1/ChangeWidgetRequest/#changewidgetrequest","text":"Updated change widget.","title":"ChangeWidgetRequest"},{"location":"v1/ChangeWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] change_type WidgetChangeType [optional] compare_to WidgetCompareTo [optional] event_query LogQueryDefinition [optional] increase_good bool Whether to show increase as good. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order_by WidgetOrderBy [optional] order_dir WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] show_present bool Whether to show the present value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteMonitorResponse/","text":"CheckCanDeleteMonitorResponse Response of monitor IDs that can or can't be safely deleted. Properties Name Type Description Notes data CheckCanDeleteMonitorResponseData errors {str: ([str],)} A mapping of Monitor ID to strings denoting where it's used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteMonitorResponse"},{"location":"v1/CheckCanDeleteMonitorResponse/#checkcandeletemonitorresponse","text":"Response of monitor IDs that can or can't be safely deleted.","title":"CheckCanDeleteMonitorResponse"},{"location":"v1/CheckCanDeleteMonitorResponse/#properties","text":"Name Type Description Notes data CheckCanDeleteMonitorResponseData errors {str: ([str],)} A mapping of Monitor ID to strings denoting where it's used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteMonitorResponseData/","text":"CheckCanDeleteMonitorResponseData Wrapper object with the list of monitor IDs. Properties Name Type Description Notes ok [int] An array of of Monitor IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteMonitorResponseData"},{"location":"v1/CheckCanDeleteMonitorResponseData/#checkcandeletemonitorresponsedata","text":"Wrapper object with the list of monitor IDs.","title":"CheckCanDeleteMonitorResponseData"},{"location":"v1/CheckCanDeleteMonitorResponseData/#properties","text":"Name Type Description Notes ok [int] An array of of Monitor IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteSLOResponse/","text":"CheckCanDeleteSLOResponse A service level objective response containing the requested object. Properties Name Type Description Notes data CheckCanDeleteSLOResponseData [optional] errors {str: (str,)} A mapping of SLO id to it's current usages. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteSLOResponse"},{"location":"v1/CheckCanDeleteSLOResponse/#checkcandeletesloresponse","text":"A service level objective response containing the requested object.","title":"CheckCanDeleteSLOResponse"},{"location":"v1/CheckCanDeleteSLOResponse/#properties","text":"Name Type Description Notes data CheckCanDeleteSLOResponseData [optional] errors {str: (str,)} A mapping of SLO id to it's current usages. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteSLOResponseData/","text":"CheckCanDeleteSLOResponseData An array of service level objective objects. Properties Name Type Description Notes ok [str] An array of of SLO IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteSLOResponseData"},{"location":"v1/CheckCanDeleteSLOResponseData/#checkcandeletesloresponsedata","text":"An array of service level objective objects.","title":"CheckCanDeleteSLOResponseData"},{"location":"v1/CheckCanDeleteSLOResponseData/#properties","text":"Name Type Description Notes ok [str] An array of of SLO IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckStatusWidgetDefinition/","text":"CheckStatusWidgetDefinition Check status shows the current status or number of results for any check performed. Properties Name Type Description Notes check str Name of the check to use in the widget. grouping WidgetGrouping type CheckStatusWidgetDefinitionType group str Group reporting a single check. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckStatusWidgetDefinition"},{"location":"v1/CheckStatusWidgetDefinition/#checkstatuswidgetdefinition","text":"Check status shows the current status or number of results for any check performed.","title":"CheckStatusWidgetDefinition"},{"location":"v1/CheckStatusWidgetDefinition/#properties","text":"Name Type Description Notes check str Name of the check to use in the widget. grouping WidgetGrouping type CheckStatusWidgetDefinitionType group str Group reporting a single check. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckStatusWidgetDefinitionType/","text":"CheckStatusWidgetDefinitionType Type of the check status widget. Properties Name Type Description Notes value str Type of the check status widget. defaults to \"check_status\", must be one of [\"check_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"CheckStatusWidgetDefinitionType"},{"location":"v1/CheckStatusWidgetDefinitionType/#checkstatuswidgetdefinitiontype","text":"Type of the check status widget.","title":"CheckStatusWidgetDefinitionType"},{"location":"v1/CheckStatusWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the check status widget. defaults to \"check_status\", must be one of [\"check_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ContentEncoding/","text":"ContentEncoding HTTP header used to compress the media-type Properties Name Type Description Notes value str HTTP header used to compress the media-type must be one of [\"gzip\", \"deflate\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ContentEncoding"},{"location":"v1/ContentEncoding/#contentencoding","text":"HTTP header used to compress the media-type","title":"ContentEncoding"},{"location":"v1/ContentEncoding/#properties","text":"Name Type Description Notes value str HTTP header used to compress the media-type must be one of [\"gzip\", \"deflate\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Creator/","text":"Creator Object describing the creator of the shared element. Properties Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Creator"},{"location":"v1/Creator/#creator","text":"Object describing the creator of the shared element.","title":"Creator"},{"location":"v1/Creator/#properties","text":"Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Dashboard/","text":"Dashboard A dashboard is Datadog\u2019s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure. Properties Name Type Description Notes layout_type DashboardLayoutType title str Title of the dashboard. widgets [Widget] List of widgets to display on the dashboard. author_handle str Identifier of the dashboard author. optional created_at datetime Creation date of the dashboard. optional description str, none_type Description of the dashboard. [optional] id str ID of the dashboard. optional is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] if omitted the server will use the default value of False modified_at datetime Modification date of the dashboard. optional notify_list [str], none_type List of handles of users to notify when changes are made to this dashboard. [optional] reflow_type DashboardReflowType [optional] template_variable_presets [DashboardTemplateVariablePreset], none_type Array of template variables saved views. [optional] template_variables [DashboardTemplateVariable], none_type List of template variables for this dashboard. [optional] url str The URL of the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"Dashboard"},{"location":"v1/Dashboard/#dashboard","text":"A dashboard is Datadog\u2019s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.","title":"Dashboard"},{"location":"v1/Dashboard/#properties","text":"Name Type Description Notes layout_type DashboardLayoutType title str Title of the dashboard. widgets [Widget] List of widgets to display on the dashboard. author_handle str Identifier of the dashboard author. optional created_at datetime Creation date of the dashboard. optional description str, none_type Description of the dashboard. [optional] id str ID of the dashboard. optional is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] if omitted the server will use the default value of False modified_at datetime Modification date of the dashboard. optional notify_list [str], none_type List of handles of users to notify when changes are made to this dashboard. [optional] reflow_type DashboardReflowType [optional] template_variable_presets [DashboardTemplateVariablePreset], none_type Array of template variables saved views. [optional] template_variables [DashboardTemplateVariable], none_type List of template variables for this dashboard. [optional] url str The URL of the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardDeleteResponse/","text":"DashboardDeleteResponse Response from the delete dashboard call. Properties Name Type Description Notes deleted_dashboard_id str ID of the deleted dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardDeleteResponse"},{"location":"v1/DashboardDeleteResponse/#dashboarddeleteresponse","text":"Response from the delete dashboard call.","title":"DashboardDeleteResponse"},{"location":"v1/DashboardDeleteResponse/#properties","text":"Name Type Description Notes deleted_dashboard_id str ID of the deleted dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardLayoutType/","text":"DashboardLayoutType Layout type of the dashboard. Properties Name Type Description Notes value str Layout type of the dashboard. must be one of [\"ordered\", \"free\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardLayoutType"},{"location":"v1/DashboardLayoutType/#dashboardlayouttype","text":"Layout type of the dashboard.","title":"DashboardLayoutType"},{"location":"v1/DashboardLayoutType/#properties","text":"Name Type Description Notes value str Layout type of the dashboard. must be one of [\"ordered\", \"free\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardList/","text":"DashboardList Your Datadog Dashboards. Properties Name Type Description Notes name str The name of the dashboard list. author Creator [optional] created datetime Date of creation of the dashboard list. optional dashboard_count int The number of dashboards in the list. optional id int The ID of the dashboard list. optional is_favorite bool Whether or not the list is in the favorites. optional modified datetime Date of last edition of the dashboard list. optional type str The type of dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"DashboardList"},{"location":"v1/DashboardList/#dashboardlist","text":"Your Datadog Dashboards.","title":"DashboardList"},{"location":"v1/DashboardList/#properties","text":"Name Type Description Notes name str The name of the dashboard list. author Creator [optional] created datetime Date of creation of the dashboard list. optional dashboard_count int The number of dashboards in the list. optional id int The ID of the dashboard list. optional is_favorite bool Whether or not the list is in the favorites. optional modified datetime Date of last edition of the dashboard list. optional type str The type of dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardListDeleteResponse/","text":"DashboardListDeleteResponse Deleted dashboard details. Properties Name Type Description Notes deleted_dashboard_list_id int ID of the deleted dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListDeleteResponse"},{"location":"v1/DashboardListDeleteResponse/#dashboardlistdeleteresponse","text":"Deleted dashboard details.","title":"DashboardListDeleteResponse"},{"location":"v1/DashboardListDeleteResponse/#properties","text":"Name Type Description Notes deleted_dashboard_list_id int ID of the deleted dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardListListResponse/","text":"DashboardListListResponse Information on your dashboard lists. Properties Name Type Description Notes dashboard_lists [DashboardList] List of all your dashboard lists. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListListResponse"},{"location":"v1/DashboardListListResponse/#dashboardlistlistresponse","text":"Information on your dashboard lists.","title":"DashboardListListResponse"},{"location":"v1/DashboardListListResponse/#properties","text":"Name Type Description Notes dashboard_lists [DashboardList] List of all your dashboard lists. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardListsApi/","text":"datadog_api_client.v1.DashboardListsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list create_dashboard_list DashboardList create_dashboard_list(body) Create a dashboard list Create an empty dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Create a dashboard list request body. # example passing only required values which don't have defaults set try: # Create a dashboard list api_response = api_instance.create_dashboard_list(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes body DashboardList Create a dashboard list request body. Return type DashboardList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_dashboard_list DashboardListDeleteResponse delete_dashboard_list(list_id) Delete a dashboard list Delete a dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to delete. # example passing only required values which don't have defaults set try: # Delete a dashboard list api_response = api_instance.delete_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes list_id int ID of the dashboard list to delete. Return type DashboardListDeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_dashboard_list DashboardList get_dashboard_list(list_id) Get a dashboard list Fetch an existing dashboard list's definition. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to fetch. # example passing only required values which don't have defaults set try: # Get a dashboard list api_response = api_instance.get_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes list_id int ID of the dashboard list to fetch. Return type DashboardList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_dashboard_lists DashboardListListResponse list_dashboard_lists() Get all dashboard lists Fetch all of your existing dashboard list definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all dashboard lists api_response = api_instance.list_dashboard_lists() pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->list_dashboard_lists: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type DashboardListListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_dashboard_list DashboardList update_dashboard_list(list_id, body) Update a dashboard list Update the name of a dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to update. body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Update a dashboard list request body. # example passing only required values which don't have defaults set try: # Update a dashboard list api_response = api_instance.update_dashboard_list(list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes list_id int ID of the dashboard list to update. body DashboardList Update a dashboard list request body. Return type DashboardList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.DashboardListsApi"},{"location":"v1/DashboardListsApi/#datadog_api_clientv1dashboardlistsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list","title":"datadog_api_client.v1.DashboardListsApi"},{"location":"v1/DashboardListsApi/#create_dashboard_list","text":"DashboardList create_dashboard_list(body) Create a dashboard list Create an empty dashboard list.","title":"create_dashboard_list"},{"location":"v1/DashboardListsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Create a dashboard list request body. # example passing only required values which don't have defaults set try: # Create a dashboard list api_response = api_instance.create_dashboard_list(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters","text":"Name Type Description Notes body DashboardList Create a dashboard list request body.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type","text":"DashboardList","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#delete_dashboard_list","text":"DashboardListDeleteResponse delete_dashboard_list(list_id) Delete a dashboard list Delete a dashboard list.","title":"delete_dashboard_list"},{"location":"v1/DashboardListsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to delete. # example passing only required values which don't have defaults set try: # Delete a dashboard list api_response = api_instance.delete_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_1","text":"Name Type Description Notes list_id int ID of the dashboard list to delete.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_1","text":"DashboardListDeleteResponse","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#get_dashboard_list","text":"DashboardList get_dashboard_list(list_id) Get a dashboard list Fetch an existing dashboard list's definition.","title":"get_dashboard_list"},{"location":"v1/DashboardListsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to fetch. # example passing only required values which don't have defaults set try: # Get a dashboard list api_response = api_instance.get_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_2","text":"Name Type Description Notes list_id int ID of the dashboard list to fetch.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_2","text":"DashboardList","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#list_dashboard_lists","text":"DashboardListListResponse list_dashboard_lists() Get all dashboard lists Fetch all of your existing dashboard list definitions.","title":"list_dashboard_lists"},{"location":"v1/DashboardListsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all dashboard lists api_response = api_instance.list_dashboard_lists() pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->list_dashboard_lists: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_3","text":"DashboardListListResponse","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#update_dashboard_list","text":"DashboardList update_dashboard_list(list_id, body) Update a dashboard list Update the name of a dashboard list.","title":"update_dashboard_list"},{"location":"v1/DashboardListsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to update. body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Update a dashboard list request body. # example passing only required values which don't have defaults set try: # Update a dashboard list api_response = api_instance.update_dashboard_list(list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_4","text":"Name Type Description Notes list_id int ID of the dashboard list to update. body DashboardList Update a dashboard list request body.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_4","text":"DashboardList","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardReflowType/","text":"DashboardReflowType Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Properties Name Type Description Notes value str Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. must be one of [\"auto\", \"fixed\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardReflowType"},{"location":"v1/DashboardReflowType/#dashboardreflowtype","text":"Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.","title":"DashboardReflowType"},{"location":"v1/DashboardReflowType/#properties","text":"Name Type Description Notes value str Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. must be one of [\"auto\", \"fixed\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardSummary/","text":"DashboardSummary Dashboard summary response. Properties Name Type Description Notes dashboards [DashboardSummaryDefinition] List of dashboard definitions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardSummary"},{"location":"v1/DashboardSummary/#dashboardsummary","text":"Dashboard summary response.","title":"DashboardSummary"},{"location":"v1/DashboardSummary/#properties","text":"Name Type Description Notes dashboards [DashboardSummaryDefinition] List of dashboard definitions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardSummaryDefinition/","text":"DashboardSummaryDefinition Dashboard definition. Properties Name Type Description Notes author_handle str Identifier of the dashboard author. [optional] created_at datetime Creation date of the dashboard. [optional] description str Description of the dashboard. [optional] id str Dashboard identifier. [optional] is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] layout_type DashboardLayoutType [optional] modified_at datetime Modification date of the dashboard. [optional] title str Title of the dashboard. [optional] url str URL of the dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardSummaryDefinition"},{"location":"v1/DashboardSummaryDefinition/#dashboardsummarydefinition","text":"Dashboard definition.","title":"DashboardSummaryDefinition"},{"location":"v1/DashboardSummaryDefinition/#properties","text":"Name Type Description Notes author_handle str Identifier of the dashboard author. [optional] created_at datetime Creation date of the dashboard. [optional] description str Description of the dashboard. [optional] id str Dashboard identifier. [optional] is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] layout_type DashboardLayoutType [optional] modified_at datetime Modification date of the dashboard. [optional] title str Title of the dashboard. [optional] url str URL of the dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardTemplateVariable/","text":"DashboardTemplateVariable Template variable. Properties Name Type Description Notes name str The name of the variable. default str, none_type The default value for the template variable on dashboard load. [optional] prefix str, none_type The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardTemplateVariable"},{"location":"v1/DashboardTemplateVariable/#dashboardtemplatevariable","text":"Template variable.","title":"DashboardTemplateVariable"},{"location":"v1/DashboardTemplateVariable/#properties","text":"Name Type Description Notes name str The name of the variable. default str, none_type The default value for the template variable on dashboard load. [optional] prefix str, none_type The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardTemplateVariablePreset/","text":"DashboardTemplateVariablePreset Template variables saved views. Properties Name Type Description Notes name str The name of the variable. [optional] template_variables [DashboardTemplateVariablePresetValue] List of variables. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardTemplateVariablePreset"},{"location":"v1/DashboardTemplateVariablePreset/#dashboardtemplatevariablepreset","text":"Template variables saved views.","title":"DashboardTemplateVariablePreset"},{"location":"v1/DashboardTemplateVariablePreset/#properties","text":"Name Type Description Notes name str The name of the variable. [optional] template_variables [DashboardTemplateVariablePresetValue] List of variables. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardTemplateVariablePresetValue/","text":"DashboardTemplateVariablePresetValue Template variables saved views. Properties Name Type Description Notes name str The name of the variable. [optional] value str The value of the template variable within the saved view. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardTemplateVariablePresetValue"},{"location":"v1/DashboardTemplateVariablePresetValue/#dashboardtemplatevariablepresetvalue","text":"Template variables saved views.","title":"DashboardTemplateVariablePresetValue"},{"location":"v1/DashboardTemplateVariablePresetValue/#properties","text":"Name Type Description Notes name str The name of the variable. [optional] value str The value of the template variable within the saved view. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardsApi/","text":"datadog_api_client.v1.DashboardsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard POST /api/v1/dashboard Create a new dashboard delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard list_dashboards GET /api/v1/dashboard Get all dashboards update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard create_dashboard Dashboard create_dashboard(body) Create a new dashboard Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the as_count() or as_rate() modifiers appended. Refer to the following documentation for more information on these modifiers. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Create a dashboard request body. # example passing only required values which don't have defaults set try: # Create a new dashboard api_response = api_instance.create_dashboard(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->create_dashboard: %s\\n\" % e) Parameters Name Type Description Notes body Dashboard Create a dashboard request body. Return type Dashboard Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_dashboard DashboardDeleteResponse delete_dashboard(dashboard_id) Delete a dashboard Delete a dashboard using the specified ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Delete a dashboard api_response = api_instance.delete_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->delete_dashboard: %s\\n\" % e) Parameters Name Type Description Notes dashboard_id str The ID of the dashboard. Return type DashboardDeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - 404 Dashboards Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_dashboard Dashboard get_dashboard(dashboard_id) Get a dashboard Get a dashboard using the specified ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Get a dashboard api_response = api_instance.get_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->get_dashboard: %s\\n\" % e) Parameters Name Type Description Notes dashboard_id str The ID of the dashboard. Return type Dashboard Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_dashboards DashboardSummary list_dashboards() Get all dashboards Get all dashboards. Note : This query will only return custom created or cloned dashboards. This query will not return preset dashboards. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) filter_shared = True # bool | When `true`, this query only returns shared custom created or cloned dashboards. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all dashboards api_response = api_instance.list_dashboards(filter_shared=filter_shared) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->list_dashboards: %s\\n\" % e) Parameters Name Type Description Notes filter_shared bool When `true`, this query only returns shared custom created or cloned dashboards. [optional] Return type DashboardSummary Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_dashboard Dashboard update_dashboard(dashboard_id, body) Update a dashboard Update a dashboard using the specified ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Update Dashboard request body. # example passing only required values which don't have defaults set try: # Update a dashboard api_response = api_instance.update_dashboard(dashboard_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->update_dashboard: %s\\n\" % e) Parameters Name Type Description Notes dashboard_id str The ID of the dashboard. body Dashboard Update Dashboard request body. Return type Dashboard Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.DashboardsApi"},{"location":"v1/DashboardsApi/#datadog_api_clientv1dashboardsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard POST /api/v1/dashboard Create a new dashboard delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard list_dashboards GET /api/v1/dashboard Get all dashboards update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard","title":"datadog_api_client.v1.DashboardsApi"},{"location":"v1/DashboardsApi/#create_dashboard","text":"Dashboard create_dashboard(body) Create a new dashboard Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the as_count() or as_rate() modifiers appended. Refer to the following documentation for more information on these modifiers.","title":"create_dashboard"},{"location":"v1/DashboardsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Create a dashboard request body. # example passing only required values which don't have defaults set try: # Create a new dashboard api_response = api_instance.create_dashboard(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->create_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters","text":"Name Type Description Notes body Dashboard Create a dashboard request body.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type","text":"Dashboard","title":"Return type"},{"location":"v1/DashboardsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#delete_dashboard","text":"DashboardDeleteResponse delete_dashboard(dashboard_id) Delete a dashboard Delete a dashboard using the specified ID.","title":"delete_dashboard"},{"location":"v1/DashboardsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Delete a dashboard api_response = api_instance.delete_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->delete_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_1","text":"Name Type Description Notes dashboard_id str The ID of the dashboard.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_1","text":"DashboardDeleteResponse","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Authentication Error - 404 Dashboards Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#get_dashboard","text":"Dashboard get_dashboard(dashboard_id) Get a dashboard Get a dashboard using the specified ID.","title":"get_dashboard"},{"location":"v1/DashboardsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Get a dashboard api_response = api_instance.get_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->get_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_2","text":"Name Type Description Notes dashboard_id str The ID of the dashboard.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_2","text":"Dashboard","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#list_dashboards","text":"DashboardSummary list_dashboards() Get all dashboards Get all dashboards. Note : This query will only return custom created or cloned dashboards. This query will not return preset dashboards.","title":"list_dashboards"},{"location":"v1/DashboardsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) filter_shared = True # bool | When `true`, this query only returns shared custom created or cloned dashboards. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all dashboards api_response = api_instance.list_dashboards(filter_shared=filter_shared) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->list_dashboards: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_3","text":"Name Type Description Notes filter_shared bool When `true`, this query only returns shared custom created or cloned dashboards. [optional]","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_3","text":"DashboardSummary","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#update_dashboard","text":"Dashboard update_dashboard(dashboard_id, body) Update a dashboard Update a dashboard using the specified ID.","title":"update_dashboard"},{"location":"v1/DashboardsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Update Dashboard request body. # example passing only required values which don't have defaults set try: # Update a dashboard api_response = api_instance.update_dashboard(dashboard_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->update_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_4","text":"Name Type Description Notes dashboard_id str The ID of the dashboard. body Dashboard Update Dashboard request body.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_4","text":"Dashboard","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DeletedMonitor/","text":"DeletedMonitor Response from the delete monitor call. Properties Name Type Description Notes deleted_monitor_id int ID of the deleted monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DeletedMonitor"},{"location":"v1/DeletedMonitor/#deletedmonitor","text":"Response from the delete monitor call.","title":"DeletedMonitor"},{"location":"v1/DeletedMonitor/#properties","text":"Name Type Description Notes deleted_monitor_id int ID of the deleted monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetDefinition/","text":"DistributionWidgetDefinition The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph\u2019s x-axis is quantity rather than time. Properties Name Type Description Notes requests [DistributionWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type DistributionWidgetDefinitionType legend_size str (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis DistributionWidgetXAxis [optional] yaxis DistributionWidgetYAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetDefinition"},{"location":"v1/DistributionWidgetDefinition/#distributionwidgetdefinition","text":"The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph\u2019s x-axis is quantity rather than time.","title":"DistributionWidgetDefinition"},{"location":"v1/DistributionWidgetDefinition/#properties","text":"Name Type Description Notes requests [DistributionWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type DistributionWidgetDefinitionType legend_size str (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis DistributionWidgetXAxis [optional] yaxis DistributionWidgetYAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetDefinitionType/","text":"DistributionWidgetDefinitionType Type of the distribution widget. Properties Name Type Description Notes value str Type of the distribution widget. defaults to \"distribution\", must be one of [\"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetDefinitionType"},{"location":"v1/DistributionWidgetDefinitionType/#distributionwidgetdefinitiontype","text":"Type of the distribution widget.","title":"DistributionWidgetDefinitionType"},{"location":"v1/DistributionWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the distribution widget. defaults to \"distribution\", must be one of [\"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetRequest/","text":"DistributionWidgetRequest Updated distribution widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetRequest"},{"location":"v1/DistributionWidgetRequest/#distributionwidgetrequest","text":"Updated distribution widget.","title":"DistributionWidgetRequest"},{"location":"v1/DistributionWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetXAxis/","text":"DistributionWidgetXAxis X Axis controls for the distribution widget. Properties Name Type Description Notes include_zero bool True includes zero. [optional] max str Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetXAxis"},{"location":"v1/DistributionWidgetXAxis/#distributionwidgetxaxis","text":"X Axis controls for the distribution widget.","title":"DistributionWidgetXAxis"},{"location":"v1/DistributionWidgetXAxis/#properties","text":"Name Type Description Notes include_zero bool True includes zero. [optional] max str Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetYAxis/","text":"DistributionWidgetYAxis Y Axis controls for the distribution widget. Properties Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear` or `log`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetYAxis"},{"location":"v1/DistributionWidgetYAxis/#distributionwidgetyaxis","text":"Y Axis controls for the distribution widget.","title":"DistributionWidgetYAxis"},{"location":"v1/DistributionWidgetYAxis/#properties","text":"Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear` or `log`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Downtime/","text":"Downtime Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags. Properties Name Type Description Notes active bool If a scheduled downtime currently exists. optional canceled int, none_type If a scheduled downtime is canceled. optional creator_id int User ID of the downtime creator. optional disabled bool If a downtime has been disabled. [optional] downtime_type int `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 end int, none_type POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. [optional] id int The downtime ID. optional message str 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 int, none_type A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. [optional] monitor_tags [str] 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 int, none_type ID of the parent Downtime. [optional] recurrence DowntimeRecurrence [optional] scope [str] 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 int POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. [optional] timezone str The timezone in which to display the downtime's start and end times in Datadog applications. [optional] updater_id int, none_type ID of the last user that updated the downtime. optional [Back to Model list] [Back to API list] [Back to README]","title":"Downtime"},{"location":"v1/Downtime/#downtime","text":"Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.","title":"Downtime"},{"location":"v1/Downtime/#properties","text":"Name Type Description Notes active bool If a scheduled downtime currently exists. optional canceled int, none_type If a scheduled downtime is canceled. optional creator_id int User ID of the downtime creator. optional disabled bool If a downtime has been disabled. [optional] downtime_type int `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 end int, none_type POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. [optional] id int The downtime ID. optional message str 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 int, none_type A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. [optional] monitor_tags [str] 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 int, none_type ID of the parent Downtime. [optional] recurrence DowntimeRecurrence [optional] scope [str] 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 int POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. [optional] timezone str The timezone in which to display the downtime's start and end times in Datadog applications. [optional] updater_id int, none_type ID of the last user that updated the downtime. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DowntimeRecurrence/","text":"DowntimeRecurrence An object defining the recurrence of the downtime. Properties Name Type Description Notes period int 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 str 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 are supported. Note : Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this downtime guide [optional] type str The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. [optional] until_date int, none_type The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. [optional] until_occurrences int, none_type How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. [optional] week_days [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"DowntimeRecurrence"},{"location":"v1/DowntimeRecurrence/#downtimerecurrence","text":"An object defining the recurrence of the downtime.","title":"DowntimeRecurrence"},{"location":"v1/DowntimeRecurrence/#properties","text":"Name Type Description Notes period int 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 str 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 are supported. Note : Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this downtime guide [optional] type str The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. [optional] until_date int, none_type The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. [optional] until_occurrences int, none_type How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. [optional] week_days [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DowntimesApi/","text":"datadog_api_client.v1.DowntimesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope create_downtime POST /api/v1/downtime Schedule a downtime get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime list_downtimes GET /api/v1/downtime Get all downtimes list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime cancel_downtime cancel_downtime(downtime_id) Cancel a downtime Cancel a downtime. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to cancel. # example passing only required values which don't have defaults set try: # Cancel a downtime api_instance.cancel_downtime(downtime_id) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtime: %s\\n\" % e) Parameters Name Type Description Notes downtime_id int ID of the downtime to cancel. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] cancel_downtimes_by_scope CanceledDowntimesIds cancel_downtimes_by_scope(body) Cancel downtimes by scope Delete all downtimes that match the scope of X . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = CancelDowntimesByScopeRequest( scope=\"host:myserver\", ) # CancelDowntimesByScopeRequest | Scope to cancel downtimes for. # example passing only required values which don't have defaults set try: # Cancel downtimes by scope api_response = api_instance.cancel_downtimes_by_scope(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtimes_by_scope: %s\\n\" % e) Parameters Name Type Description Notes body CancelDowntimesByScopeRequest Scope to cancel downtimes for. Return type CanceledDowntimesIds Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtimes not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_downtime Downtime create_downtime(body) Schedule a downtime Schedule a downtime. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Schedule a downtime request body. # example passing only required values which don't have defaults set try: # Schedule a downtime api_response = api_instance.create_downtime(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->create_downtime: %s\\n\" % e) Parameters Name Type Description Notes body Downtime Schedule a downtime request body. Return type Downtime Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_downtime Downtime get_downtime(downtime_id) Get a downtime Get downtime detail by downtime_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to fetch. # example passing only required values which don't have defaults set try: # Get a downtime api_response = api_instance.get_downtime(downtime_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->get_downtime: %s\\n\" % e) Parameters Name Type Description Notes downtime_id int ID of the downtime to fetch. Return type Downtime Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_downtimes [Downtime] list_downtimes() Get all downtimes Get all scheduled downtimes. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) current_only = True # bool | Only return downtimes that are active when the request is made. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all downtimes api_response = api_instance.list_downtimes(current_only=current_only) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_downtimes: %s\\n\" % e) Parameters Name Type Description Notes current_only bool Only return downtimes that are active when the request is made. [optional] Return type [Downtime] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_monitor_downtimes [Downtime] list_monitor_downtimes(monitor_id) Get all downtimes for a monitor Get all downtimes for the specified monitor Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) monitor_id = 1 # int | The id of the monitor # example passing only required values which don't have defaults set try: # Get all downtimes for a monitor api_response = api_instance.list_monitor_downtimes(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_monitor_downtimes: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The id of the monitor Return type [Downtime] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_downtime Downtime update_downtime(downtime_id, body) Update a downtime Update a single downtime by downtime_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to update. body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Update a downtime request body. # example passing only required values which don't have defaults set try: # Update a downtime api_response = api_instance.update_downtime(downtime_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->update_downtime: %s\\n\" % e) Parameters Name Type Description Notes downtime_id int ID of the downtime to update. body Downtime Update a downtime request body. Return type Downtime Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.DowntimesApi"},{"location":"v1/DowntimesApi/#datadog_api_clientv1downtimesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope create_downtime POST /api/v1/downtime Schedule a downtime get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime list_downtimes GET /api/v1/downtime Get all downtimes list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime","title":"datadog_api_client.v1.DowntimesApi"},{"location":"v1/DowntimesApi/#cancel_downtime","text":"cancel_downtime(downtime_id) Cancel a downtime Cancel a downtime.","title":"cancel_downtime"},{"location":"v1/DowntimesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to cancel. # example passing only required values which don't have defaults set try: # Cancel a downtime api_instance.cancel_downtime(downtime_id) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters","text":"Name Type Description Notes downtime_id int ID of the downtime to cancel.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type","text":"void (empty response body)","title":"Return type"},{"location":"v1/DowntimesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details","text":"Status code Description Response headers 204 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#cancel_downtimes_by_scope","text":"CanceledDowntimesIds cancel_downtimes_by_scope(body) Cancel downtimes by scope Delete all downtimes that match the scope of X .","title":"cancel_downtimes_by_scope"},{"location":"v1/DowntimesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = CancelDowntimesByScopeRequest( scope=\"host:myserver\", ) # CancelDowntimesByScopeRequest | Scope to cancel downtimes for. # example passing only required values which don't have defaults set try: # Cancel downtimes by scope api_response = api_instance.cancel_downtimes_by_scope(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtimes_by_scope: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_1","text":"Name Type Description Notes body CancelDowntimesByScopeRequest Scope to cancel downtimes for.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_1","text":"CanceledDowntimesIds","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtimes not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#create_downtime","text":"Downtime create_downtime(body) Schedule a downtime Schedule a downtime.","title":"create_downtime"},{"location":"v1/DowntimesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Schedule a downtime request body. # example passing only required values which don't have defaults set try: # Schedule a downtime api_response = api_instance.create_downtime(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->create_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_2","text":"Name Type Description Notes body Downtime Schedule a downtime request body.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_2","text":"Downtime","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#get_downtime","text":"Downtime get_downtime(downtime_id) Get a downtime Get downtime detail by downtime_id .","title":"get_downtime"},{"location":"v1/DowntimesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to fetch. # example passing only required values which don't have defaults set try: # Get a downtime api_response = api_instance.get_downtime(downtime_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->get_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_3","text":"Name Type Description Notes downtime_id int ID of the downtime to fetch.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_3","text":"Downtime","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#list_downtimes","text":"[Downtime] list_downtimes() Get all downtimes Get all scheduled downtimes.","title":"list_downtimes"},{"location":"v1/DowntimesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) current_only = True # bool | Only return downtimes that are active when the request is made. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all downtimes api_response = api_instance.list_downtimes(current_only=current_only) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_downtimes: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_4","text":"Name Type Description Notes current_only bool Only return downtimes that are active when the request is made. [optional]","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_4","text":"[Downtime]","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#list_monitor_downtimes","text":"[Downtime] list_monitor_downtimes(monitor_id) Get all downtimes for a monitor Get all downtimes for the specified monitor","title":"list_monitor_downtimes"},{"location":"v1/DowntimesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) monitor_id = 1 # int | The id of the monitor # example passing only required values which don't have defaults set try: # Get all downtimes for a monitor api_response = api_instance.list_monitor_downtimes(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_monitor_downtimes: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_5","text":"Name Type Description Notes monitor_id int The id of the monitor","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_5","text":"[Downtime]","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#update_downtime","text":"Downtime update_downtime(downtime_id, body) Update a downtime Update a single downtime by downtime_id .","title":"update_downtime"},{"location":"v1/DowntimesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to update. body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Update a downtime request body. # example passing only required values which don't have defaults set try: # Update a downtime api_response = api_instance.update_downtime(downtime_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->update_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_6","text":"Name Type Description Notes downtime_id int ID of the downtime to update. body Downtime Update a downtime request body.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_6","text":"Downtime","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/Event/","text":"Event Object representing an event. Properties Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Event"},{"location":"v1/Event/#event","text":"Object representing an event.","title":"Event"},{"location":"v1/Event/#properties","text":"Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventAlertType/","text":"EventAlertType If an alert event is enabled, set its type. For example, error , warning , info , success , user_update , recommendation , and snapshot . Properties Name Type Description Notes value str If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. must be one of [\"error\", \"warning\", \"info\", \"success\", \"user_update\", \"recommendation\", \"snapshot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventAlertType"},{"location":"v1/EventAlertType/#eventalerttype","text":"If an alert event is enabled, set its type. For example, error , warning , info , success , user_update , recommendation , and snapshot .","title":"EventAlertType"},{"location":"v1/EventAlertType/#properties","text":"Name Type Description Notes value str If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. must be one of [\"error\", \"warning\", \"info\", \"success\", \"user_update\", \"recommendation\", \"snapshot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventCreateRequest/","text":"EventCreateRequest Object representing an event. Properties Name Type Description Notes text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. aggregation_key str 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 [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"EventCreateRequest"},{"location":"v1/EventCreateRequest/#eventcreaterequest","text":"Object representing an event.","title":"EventCreateRequest"},{"location":"v1/EventCreateRequest/#properties","text":"Name Type Description Notes text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. aggregation_key str 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 [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventCreateResponse/","text":"EventCreateResponse Object containing an event response. Properties Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] status str A status. [optional] tags [str] A list of tags to apply to the event. [optional] text str The body of the event. Limited to 4000 characters. The text supports markdown. Use `msg_text` with the Datadog Ruby library. [optional] title str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"EventCreateResponse"},{"location":"v1/EventCreateResponse/#eventcreateresponse","text":"Object containing an event response.","title":"EventCreateResponse"},{"location":"v1/EventCreateResponse/#properties","text":"Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] status str A status. [optional] tags [str] A list of tags to apply to the event. [optional] text str The body of the event. Limited to 4000 characters. The text supports markdown. Use `msg_text` with the Datadog Ruby library. [optional] title str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventListResponse/","text":"EventListResponse An event list response. Properties Name Type Description Notes events [Event] An array of events. [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventListResponse"},{"location":"v1/EventListResponse/#eventlistresponse","text":"An event list response.","title":"EventListResponse"},{"location":"v1/EventListResponse/#properties","text":"Name Type Description Notes events [Event] An array of events. [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventPriority/","text":"EventPriority The priority of the event. For example, normal or low . Properties Name Type Description Notes value str The priority of the event. For example, `normal` or `low`. must be one of [\"normal\", \"low\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventPriority"},{"location":"v1/EventPriority/#eventpriority","text":"The priority of the event. For example, normal or low .","title":"EventPriority"},{"location":"v1/EventPriority/#properties","text":"Name Type Description Notes value str The priority of the event. For example, `normal` or `low`. must be one of [\"normal\", \"low\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventQueryDefinition/","text":"EventQueryDefinition The event query. Properties Name Type Description Notes search str The query being made on the event. tags_execution str The execution method for multi-value filters. Can be either and or or. [Back to Model list] [Back to API list] [Back to README]","title":"EventQueryDefinition"},{"location":"v1/EventQueryDefinition/#eventquerydefinition","text":"The event query.","title":"EventQueryDefinition"},{"location":"v1/EventQueryDefinition/#properties","text":"Name Type Description Notes search str The query being made on the event. tags_execution str The execution method for multi-value filters. Can be either and or or. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventResponse/","text":"EventResponse Object containing an event response. Properties Name Type Description Notes event Event [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventResponse"},{"location":"v1/EventResponse/#eventresponse","text":"Object containing an event response.","title":"EventResponse"},{"location":"v1/EventResponse/#properties","text":"Name Type Description Notes event Event [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventStreamWidgetDefinition/","text":"EventStreamWidgetDefinition The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. Properties Name Type Description Notes query str Query to filter the event stream with. type EventStreamWidgetDefinitionType event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventStreamWidgetDefinition"},{"location":"v1/EventStreamWidgetDefinition/#eventstreamwidgetdefinition","text":"The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.","title":"EventStreamWidgetDefinition"},{"location":"v1/EventStreamWidgetDefinition/#properties","text":"Name Type Description Notes query str Query to filter the event stream with. type EventStreamWidgetDefinitionType event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventStreamWidgetDefinitionType/","text":"EventStreamWidgetDefinitionType Type of the event stream widget. Properties Name Type Description Notes value str Type of the event stream widget. defaults to \"event_stream\", must be one of [\"event_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventStreamWidgetDefinitionType"},{"location":"v1/EventStreamWidgetDefinitionType/#eventstreamwidgetdefinitiontype","text":"Type of the event stream widget.","title":"EventStreamWidgetDefinitionType"},{"location":"v1/EventStreamWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the event stream widget. defaults to \"event_stream\", must be one of [\"event_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventTimelineWidgetDefinition/","text":"EventTimelineWidgetDefinition The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards. Properties Name Type Description Notes query str Query to filter the event timeline with. type EventTimelineWidgetDefinitionType tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventTimelineWidgetDefinition"},{"location":"v1/EventTimelineWidgetDefinition/#eventtimelinewidgetdefinition","text":"The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.","title":"EventTimelineWidgetDefinition"},{"location":"v1/EventTimelineWidgetDefinition/#properties","text":"Name Type Description Notes query str Query to filter the event timeline with. type EventTimelineWidgetDefinitionType tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventTimelineWidgetDefinitionType/","text":"EventTimelineWidgetDefinitionType Type of the event timeline widget. Properties Name Type Description Notes value str Type of the event timeline widget. defaults to \"event_timeline\", must be one of [\"event_timeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventTimelineWidgetDefinitionType"},{"location":"v1/EventTimelineWidgetDefinitionType/#eventtimelinewidgetdefinitiontype","text":"Type of the event timeline widget.","title":"EventTimelineWidgetDefinitionType"},{"location":"v1/EventTimelineWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the event timeline widget. defaults to \"event_timeline\", must be one of [\"event_timeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventsApi/","text":"datadog_api_client.v1.EventsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_event POST /api/v1/events Post an event get_event GET /api/v1/events/{event_id} Get an event list_events GET /api/v1/events Query the event stream create_event EventCreateResponse create_event(body) Post an event This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) body = EventCreateRequest( aggregation_key=\"aggregation_key_example\", alert_type=EventAlertType(\"info\"), date_happened=1, device_name=\"device_name_example\", host=\"host_example\", id=1, payload=\"{}\", priority=EventPriority(\"normal\"), related_event_id=1, source_type_name=\"source_type_name_example\", tags=[\"environment:test\"], text=\"Oh boy!\", title=\"Did you hear the news today?\", url=\"url_example\", ) # EventCreateRequest | Event request object # example passing only required values which don't have defaults set try: # Post an event api_response = api_instance.create_event(body) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->create_event: %s\\n\" % e) Parameters Name Type Description Notes body EventCreateRequest Event request object Return type EventCreateResponse Authorization apiKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 202 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_event EventResponse get_event(event_id) Get an event This endpoint allows you to query for event details. Note : If the event you\u2019re querying contains markdown formatting of any kind, you may see characters such as % , \\\\ , n in your output. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) event_id = 1 # int | The ID of the event. # example passing only required values which don't have defaults set try: # Get an event api_response = api_instance.get_event(event_id) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->get_event: %s\\n\" % e) Parameters Name Type Description Notes event_id int The ID of the event. Return type EventResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_events EventListResponse list_events(start, end) Query the event stream The event stream can be queried and filtered by time, priority, sources and tags. Notes : - If the event you\u2019re querying contains markdown formatting of any kind, 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. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) start = 1 # int | POSIX timestamp. end = 1 # int | POSIX timestamp. priority = EventPriority(\"normal\") # EventPriority | Priority of your events, either `low` or `normal`. (optional) sources = \"sources_example\" # str | A comma separated string of sources. (optional) tags = \"host:host0\" # str | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. (optional) unaggregated = True # bool | 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 = True # bool | 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 = 1 # int | 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) # example passing only required values which don't have defaults set try: # Query the event stream api_response = api_instance.list_events(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Query the event stream api_response = api_instance.list_events(start, end, priority=priority, sources=sources, tags=tags, unaggregated=unaggregated, exclude_aggregate=exclude_aggregate, page=page) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e) Parameters Name Type Description Notes start int POSIX timestamp. end int POSIX timestamp. priority EventPriority Priority of your events, either `low` or `normal`. [optional] sources str A comma separated string of sources. [optional] tags str A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. [optional] unaggregated bool 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 bool 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 int 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 EventListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.EventsApi"},{"location":"v1/EventsApi/#datadog_api_clientv1eventsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_event POST /api/v1/events Post an event get_event GET /api/v1/events/{event_id} Get an event list_events GET /api/v1/events Query the event stream","title":"datadog_api_client.v1.EventsApi"},{"location":"v1/EventsApi/#create_event","text":"EventCreateResponse create_event(body) Post an event This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.","title":"create_event"},{"location":"v1/EventsApi/#example","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) body = EventCreateRequest( aggregation_key=\"aggregation_key_example\", alert_type=EventAlertType(\"info\"), date_happened=1, device_name=\"device_name_example\", host=\"host_example\", id=1, payload=\"{}\", priority=EventPriority(\"normal\"), related_event_id=1, source_type_name=\"source_type_name_example\", tags=[\"environment:test\"], text=\"Oh boy!\", title=\"Did you hear the news today?\", url=\"url_example\", ) # EventCreateRequest | Event request object # example passing only required values which don't have defaults set try: # Post an event api_response = api_instance.create_event(body) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->create_event: %s\\n\" % e)","title":"Example"},{"location":"v1/EventsApi/#parameters","text":"Name Type Description Notes body EventCreateRequest Event request object","title":"Parameters"},{"location":"v1/EventsApi/#return-type","text":"EventCreateResponse","title":"Return type"},{"location":"v1/EventsApi/#authorization","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/EventsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/EventsApi/#http-response-details","text":"Status code Description Response headers 202 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/EventsApi/#get_event","text":"EventResponse get_event(event_id) Get an event This endpoint allows you to query for event details. Note : If the event you\u2019re querying contains markdown formatting of any kind, you may see characters such as % , \\\\ , n in your output.","title":"get_event"},{"location":"v1/EventsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) event_id = 1 # int | The ID of the event. # example passing only required values which don't have defaults set try: # Get an event api_response = api_instance.get_event(event_id) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->get_event: %s\\n\" % e)","title":"Example"},{"location":"v1/EventsApi/#parameters_1","text":"Name Type Description Notes event_id int The ID of the event.","title":"Parameters"},{"location":"v1/EventsApi/#return-type_1","text":"EventResponse","title":"Return type"},{"location":"v1/EventsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/EventsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/EventsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/EventsApi/#list_events","text":"EventListResponse list_events(start, end) Query the event stream The event stream can be queried and filtered by time, priority, sources and tags. Notes : - If the event you\u2019re querying contains markdown formatting of any kind, 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.","title":"list_events"},{"location":"v1/EventsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) start = 1 # int | POSIX timestamp. end = 1 # int | POSIX timestamp. priority = EventPriority(\"normal\") # EventPriority | Priority of your events, either `low` or `normal`. (optional) sources = \"sources_example\" # str | A comma separated string of sources. (optional) tags = \"host:host0\" # str | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. (optional) unaggregated = True # bool | 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 = True # bool | 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 = 1 # int | 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) # example passing only required values which don't have defaults set try: # Query the event stream api_response = api_instance.list_events(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Query the event stream api_response = api_instance.list_events(start, end, priority=priority, sources=sources, tags=tags, unaggregated=unaggregated, exclude_aggregate=exclude_aggregate, page=page) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e)","title":"Example"},{"location":"v1/EventsApi/#parameters_2","text":"Name Type Description Notes start int POSIX timestamp. end int POSIX timestamp. priority EventPriority Priority of your events, either `low` or `normal`. [optional] sources str A comma separated string of sources. [optional] tags str A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. [optional] unaggregated bool 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 bool 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 int 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]","title":"Parameters"},{"location":"v1/EventsApi/#return-type_2","text":"EventListResponse","title":"Return type"},{"location":"v1/EventsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/EventsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/EventsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/FormulaAndFunctionEventAggregation/","text":"FormulaAndFunctionEventAggregation Aggregation methods for event platform queries. Properties Name Type Description Notes value str Aggregation methods for event platform queries. must be one of [\"count\", \"cardinality\", \"median\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventAggregation"},{"location":"v1/FormulaAndFunctionEventAggregation/#formulaandfunctioneventaggregation","text":"Aggregation methods for event platform queries.","title":"FormulaAndFunctionEventAggregation"},{"location":"v1/FormulaAndFunctionEventAggregation/#properties","text":"Name Type Description Notes value str Aggregation methods for event platform queries. must be one of [\"count\", \"cardinality\", \"median\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryDefinition/","text":"FormulaAndFunctionEventQueryDefinition A formula and functions events query. Properties Name Type Description Notes compute FormulaAndFunctionEventQueryDefinitionCompute data_source FormulaAndFunctionEventsDataSource name str Name of the query for use in formulas. group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryDefinition"},{"location":"v1/FormulaAndFunctionEventQueryDefinition/#formulaandfunctioneventquerydefinition","text":"A formula and functions events query.","title":"FormulaAndFunctionEventQueryDefinition"},{"location":"v1/FormulaAndFunctionEventQueryDefinition/#properties","text":"Name Type Description Notes compute FormulaAndFunctionEventQueryDefinitionCompute data_source FormulaAndFunctionEventsDataSource name str Name of the query for use in formulas. group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionCompute/","text":"FormulaAndFunctionEventQueryDefinitionCompute Compute options. Properties Name Type Description Notes aggregation FormulaAndFunctionEventAggregation interval int A time interval in milliseconds. [optional] metric str Measurable attribute to compute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryDefinitionCompute"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionCompute/#formulaandfunctioneventquerydefinitioncompute","text":"Compute options.","title":"FormulaAndFunctionEventQueryDefinitionCompute"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionCompute/#properties","text":"Name Type Description Notes aggregation FormulaAndFunctionEventAggregation interval int A time interval in milliseconds. [optional] metric str Measurable attribute to compute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionSearch/","text":"FormulaAndFunctionEventQueryDefinitionSearch Search options. Properties Name Type Description Notes query str Events search string. [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryDefinitionSearch"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionSearch/#formulaandfunctioneventquerydefinitionsearch","text":"Search options.","title":"FormulaAndFunctionEventQueryDefinitionSearch"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionSearch/#properties","text":"Name Type Description Notes query str Events search string. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryGroupBy/","text":"FormulaAndFunctionEventQueryGroupBy List of objects used to group by. Properties Name Type Description Notes facet str Event facet. limit int Number of groups to return. [optional] sort FormulaAndFunctionEventQueryGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryGroupBy"},{"location":"v1/FormulaAndFunctionEventQueryGroupBy/#formulaandfunctioneventquerygroupby","text":"List of objects used to group by.","title":"FormulaAndFunctionEventQueryGroupBy"},{"location":"v1/FormulaAndFunctionEventQueryGroupBy/#properties","text":"Name Type Description Notes facet str Event facet. limit int Number of groups to return. [optional] sort FormulaAndFunctionEventQueryGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryGroupBySort/","text":"FormulaAndFunctionEventQueryGroupBySort Options for sorting group by results. Properties Name Type Description Notes aggregation FormulaAndFunctionEventAggregation metric str Metric used for sorting group by results. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryGroupBySort"},{"location":"v1/FormulaAndFunctionEventQueryGroupBySort/#formulaandfunctioneventquerygroupbysort","text":"Options for sorting group by results.","title":"FormulaAndFunctionEventQueryGroupBySort"},{"location":"v1/FormulaAndFunctionEventQueryGroupBySort/#properties","text":"Name Type Description Notes aggregation FormulaAndFunctionEventAggregation metric str Metric used for sorting group by results. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventsDataSource/","text":"FormulaAndFunctionEventsDataSource Data source for event platform-based queries. Properties Name Type Description Notes value str Data source for event platform-based queries. must be one of [\"logs\", \"spans\", \"network\", \"rum\", \"security_signals\", \"profiles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventsDataSource"},{"location":"v1/FormulaAndFunctionEventsDataSource/#formulaandfunctioneventsdatasource","text":"Data source for event platform-based queries.","title":"FormulaAndFunctionEventsDataSource"},{"location":"v1/FormulaAndFunctionEventsDataSource/#properties","text":"Name Type Description Notes value str Data source for event platform-based queries. must be one of [\"logs\", \"spans\", \"network\", \"rum\", \"security_signals\", \"profiles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionMetricAggregation/","text":"FormulaAndFunctionMetricAggregation The aggregation methods available for metrics queries. Properties Name Type Description Notes value str The aggregation methods available for metrics queries. must be one of [\"avg\", \"min\", \"max\", \"sum\", \"last\", \"area\", \"l2norm\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionMetricAggregation"},{"location":"v1/FormulaAndFunctionMetricAggregation/#formulaandfunctionmetricaggregation","text":"The aggregation methods available for metrics queries.","title":"FormulaAndFunctionMetricAggregation"},{"location":"v1/FormulaAndFunctionMetricAggregation/#properties","text":"Name Type Description Notes value str The aggregation methods available for metrics queries. must be one of [\"avg\", \"min\", \"max\", \"sum\", \"last\", \"area\", \"l2norm\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionMetricDataSource/","text":"FormulaAndFunctionMetricDataSource Data source for metrics queries. Properties Name Type Description Notes value str Data source for metrics queries. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionMetricDataSource"},{"location":"v1/FormulaAndFunctionMetricDataSource/#formulaandfunctionmetricdatasource","text":"Data source for metrics queries.","title":"FormulaAndFunctionMetricDataSource"},{"location":"v1/FormulaAndFunctionMetricDataSource/#properties","text":"Name Type Description Notes value str Data source for metrics queries. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionMetricQueryDefinition/","text":"FormulaAndFunctionMetricQueryDefinition A formula and functions metrics query. Properties Name Type Description Notes data_source FormulaAndFunctionMetricDataSource name str Name of the query for use in formulas. query str Metrics query definition. aggregator FormulaAndFunctionMetricAggregation [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionMetricQueryDefinition"},{"location":"v1/FormulaAndFunctionMetricQueryDefinition/#formulaandfunctionmetricquerydefinition","text":"A formula and functions metrics query.","title":"FormulaAndFunctionMetricQueryDefinition"},{"location":"v1/FormulaAndFunctionMetricQueryDefinition/#properties","text":"Name Type Description Notes data_source FormulaAndFunctionMetricDataSource name str Name of the query for use in formulas. query str Metrics query definition. aggregator FormulaAndFunctionMetricAggregation [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionProcessQueryDataSource/","text":"FormulaAndFunctionProcessQueryDataSource Data sources that rely on the process backend. Properties Name Type Description Notes value str Data sources that rely on the process backend. must be one of [\"process\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionProcessQueryDataSource"},{"location":"v1/FormulaAndFunctionProcessQueryDataSource/#formulaandfunctionprocessquerydatasource","text":"Data sources that rely on the process backend.","title":"FormulaAndFunctionProcessQueryDataSource"},{"location":"v1/FormulaAndFunctionProcessQueryDataSource/#properties","text":"Name Type Description Notes value str Data sources that rely on the process backend. must be one of [\"process\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionProcessQueryDefinition/","text":"FormulaAndFunctionProcessQueryDefinition Process query using formulas and functions. Properties Name Type Description Notes data_source FormulaAndFunctionProcessQueryDataSource metric str Process metric name. name str Name of query for use in formulas. aggregator FormulaAndFunctionMetricAggregation [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionProcessQueryDefinition"},{"location":"v1/FormulaAndFunctionProcessQueryDefinition/#formulaandfunctionprocessquerydefinition","text":"Process query using formulas and functions.","title":"FormulaAndFunctionProcessQueryDefinition"},{"location":"v1/FormulaAndFunctionProcessQueryDefinition/#properties","text":"Name Type Description Notes data_source FormulaAndFunctionProcessQueryDataSource metric str Process metric name. name str Name of query for use in formulas. aggregator FormulaAndFunctionMetricAggregation [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionQueryDefinition/","text":"FormulaAndFunctionQueryDefinition A formula and function query. Properties Name Type Description Notes aggregator FormulaAndFunctionMetricAggregation [optional] group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] data_source FormulaAndFunctionProcessQueryDataSource [optional] name str Name of query for use in formulas. [optional] query str Metrics query definition. [optional] compute FormulaAndFunctionEventQueryDefinitionCompute [optional] metric str Process metric name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionQueryDefinition"},{"location":"v1/FormulaAndFunctionQueryDefinition/#formulaandfunctionquerydefinition","text":"A formula and function query.","title":"FormulaAndFunctionQueryDefinition"},{"location":"v1/FormulaAndFunctionQueryDefinition/#properties","text":"Name Type Description Notes aggregator FormulaAndFunctionMetricAggregation [optional] group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] data_source FormulaAndFunctionProcessQueryDataSource [optional] name str Name of query for use in formulas. [optional] query str Metrics query definition. [optional] compute FormulaAndFunctionEventQueryDefinitionCompute [optional] metric str Process metric name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionResponseFormat/","text":"FormulaAndFunctionResponseFormat Timeseries or Scalar response. This feature is currently in beta. Properties Name Type Description Notes value str Timeseries or Scalar response. This feature is currently in beta. must be one of [\"timeseries\", \"scalar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionResponseFormat"},{"location":"v1/FormulaAndFunctionResponseFormat/#formulaandfunctionresponseformat","text":"Timeseries or Scalar response. This feature is currently in beta.","title":"FormulaAndFunctionResponseFormat"},{"location":"v1/FormulaAndFunctionResponseFormat/#properties","text":"Name Type Description Notes value str Timeseries or Scalar response. This feature is currently in beta. must be one of [\"timeseries\", \"scalar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FreeTextWidgetDefinition/","text":"FreeTextWidgetDefinition Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards. Properties Name Type Description Notes text str Text to display. type FreeTextWidgetDefinitionType color str Color of the text. [optional] font_size str Size of the text. [optional] text_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FreeTextWidgetDefinition"},{"location":"v1/FreeTextWidgetDefinition/#freetextwidgetdefinition","text":"Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.","title":"FreeTextWidgetDefinition"},{"location":"v1/FreeTextWidgetDefinition/#properties","text":"Name Type Description Notes text str Text to display. type FreeTextWidgetDefinitionType color str Color of the text. [optional] font_size str Size of the text. [optional] text_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FreeTextWidgetDefinitionType/","text":"FreeTextWidgetDefinitionType Type of the free text widget. Properties Name Type Description Notes value str Type of the free text widget. defaults to \"free_text\", must be one of [\"free_text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FreeTextWidgetDefinitionType"},{"location":"v1/FreeTextWidgetDefinitionType/#freetextwidgetdefinitiontype","text":"Type of the free text widget.","title":"FreeTextWidgetDefinitionType"},{"location":"v1/FreeTextWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the free text widget. defaults to \"free_text\", must be one of [\"free_text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GCPAccount/","text":"GCPAccount Your Google Cloud Platform Account. Properties Name Type Description Notes auth_provider_x509_cert_url str Should be `https://www.googleapis.com/oauth2/v1/certs`. [optional] auth_uri str Should be `https://accounts.google.com/o/oauth2/auth`. [optional] automute bool Silence monitors for expected GCE instance shutdowns. [optional] client_email str Your email found in your JSON service account key. [optional] client_id str Your ID found in your JSON service account key. [optional] client_x509_cert_url str Should be `https://www.googleapis.com/robot/v1/metadata/x509/` where `` is the email found in your JSON service account key. [optional] errors [str] An array of errors. [optional] host_filters str 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 str Your private key name found in your JSON service account key. [optional] private_key_id str Your private key ID found in your JSON service account key. [optional] project_id str Your Google Cloud project ID found in your JSON service account key. [optional] token_uri str Should be `https://accounts.google.com/o/oauth2/token`. [optional] type str The value for service_account found in your JSON service account key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GCPAccount"},{"location":"v1/GCPAccount/#gcpaccount","text":"Your Google Cloud Platform Account.","title":"GCPAccount"},{"location":"v1/GCPAccount/#properties","text":"Name Type Description Notes auth_provider_x509_cert_url str Should be `https://www.googleapis.com/oauth2/v1/certs`. [optional] auth_uri str Should be `https://accounts.google.com/o/oauth2/auth`. [optional] automute bool Silence monitors for expected GCE instance shutdowns. [optional] client_email str Your email found in your JSON service account key. [optional] client_id str Your ID found in your JSON service account key. [optional] client_x509_cert_url str Should be `https://www.googleapis.com/robot/v1/metadata/x509/` where `` is the email found in your JSON service account key. [optional] errors [str] An array of errors. [optional] host_filters str 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 str Your private key name found in your JSON service account key. [optional] private_key_id str Your private key ID found in your JSON service account key. [optional] project_id str Your Google Cloud project ID found in your JSON service account key. [optional] token_uri str Should be `https://accounts.google.com/o/oauth2/token`. [optional] type str The value for service_account found in your JSON service account key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GCPAccountListResponse/","text":"GCPAccountListResponse Array of GCP account responses. Properties Name Type Description Notes value [GCPAccount] Array of GCP account responses. [Back to Model list] [Back to API list] [Back to README]","title":"GCPAccountListResponse"},{"location":"v1/GCPAccountListResponse/#gcpaccountlistresponse","text":"Array of GCP account responses.","title":"GCPAccountListResponse"},{"location":"v1/GCPAccountListResponse/#properties","text":"Name Type Description Notes value [GCPAccount] Array of GCP account responses. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GCPIntegrationApi/","text":"datadog_api_client.v1.GCPIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration create_gcp_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_gcp_integration(body) Create a GCP integration Create a Datadog-GCP integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Create a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Create a GCP integration api_response = api_instance.create_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->create_gcp_integration: %s\\n\" % e) Parameters Name Type Description Notes body GCPAccount Create a Datadog-GCP integration. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_gcp_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_gcp_integration(body) Delete a GCP integration Delete a given Datadog-GCP integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Delete a given Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Delete a GCP integration api_response = api_instance.delete_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->delete_gcp_integration: %s\\n\" % e) Parameters Name Type Description Notes body GCPAccount Delete a given Datadog-GCP integration. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_gcp_integration GCPAccountListResponse list_gcp_integration() List all GCP integrations List all Datadog-GCP integrations configured in your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all GCP integrations api_response = api_instance.list_gcp_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->list_gcp_integration: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type GCPAccountListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_gcp_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_gcp_integration(body) Update a GCP integration Update a Datadog-GCP integrations host_filters and/or auto-mute. Requires a project_id and client_email , however these fields cannot be updated. If you need to update these fields, delete and use the create ( POST ) endpoint. The unspecified fields will keep their original values. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Update a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Update a GCP integration api_response = api_instance.update_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->update_gcp_integration: %s\\n\" % e) Parameters Name Type Description Notes body GCPAccount Update a Datadog-GCP integration. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.GCPIntegrationApi"},{"location":"v1/GCPIntegrationApi/#datadog_api_clientv1gcpintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration","title":"datadog_api_client.v1.GCPIntegrationApi"},{"location":"v1/GCPIntegrationApi/#create_gcp_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_gcp_integration(body) Create a GCP integration Create a Datadog-GCP integration.","title":"create_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Create a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Create a GCP integration api_response = api_instance.create_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->create_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters","text":"Name Type Description Notes body GCPAccount Create a Datadog-GCP integration.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GCPIntegrationApi/#delete_gcp_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_gcp_integration(body) Delete a GCP integration Delete a given Datadog-GCP integration.","title":"delete_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Delete a given Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Delete a GCP integration api_response = api_instance.delete_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->delete_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters_1","text":"Name Type Description Notes body GCPAccount Delete a given Datadog-GCP integration.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GCPIntegrationApi/#list_gcp_integration","text":"GCPAccountListResponse list_gcp_integration() List all GCP integrations List all Datadog-GCP integrations configured in your Datadog account.","title":"list_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all GCP integrations api_response = api_instance.list_gcp_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->list_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type_2","text":"GCPAccountListResponse","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GCPIntegrationApi/#update_gcp_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_gcp_integration(body) Update a GCP integration Update a Datadog-GCP integrations host_filters and/or auto-mute. Requires a project_id and client_email , however these fields cannot be updated. If you need to update these fields, delete and use the create ( POST ) endpoint. The unspecified fields will keep their original values.","title":"update_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Update a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Update a GCP integration api_response = api_instance.update_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->update_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters_3","text":"Name Type Description Notes body GCPAccount Update a Datadog-GCP integration.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GeomapWidgetDefinition/","text":"GeomapWidgetDefinition This visualization displays a series of values by country on a world map. Properties Name Type Description Notes requests [GeomapWidgetRequest] 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 for information about building the `REQUEST_SCHEMA`. style GeomapWidgetDefinitionStyle type GeomapWidgetDefinitionType view GeomapWidgetDefinitionView custom_links [WidgetCustomLink] A list of custom links. [optional] time WidgetTime [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str The size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinition"},{"location":"v1/GeomapWidgetDefinition/#geomapwidgetdefinition","text":"This visualization displays a series of values by country on a world map.","title":"GeomapWidgetDefinition"},{"location":"v1/GeomapWidgetDefinition/#properties","text":"Name Type Description Notes requests [GeomapWidgetRequest] 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 for information about building the `REQUEST_SCHEMA`. style GeomapWidgetDefinitionStyle type GeomapWidgetDefinitionType view GeomapWidgetDefinitionView custom_links [WidgetCustomLink] A list of custom links. [optional] time WidgetTime [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str The size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetDefinitionStyle/","text":"GeomapWidgetDefinitionStyle The style to apply to the widget. Properties Name Type Description Notes palette str The color palette to apply to the widget. palette_flip bool Whether to flip the palette tones. [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinitionStyle"},{"location":"v1/GeomapWidgetDefinitionStyle/#geomapwidgetdefinitionstyle","text":"The style to apply to the widget.","title":"GeomapWidgetDefinitionStyle"},{"location":"v1/GeomapWidgetDefinitionStyle/#properties","text":"Name Type Description Notes palette str The color palette to apply to the widget. palette_flip bool Whether to flip the palette tones. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetDefinitionType/","text":"GeomapWidgetDefinitionType Type of the geomap widget. Properties Name Type Description Notes value str Type of the geomap widget. defaults to \"geomap\", must be one of [\"geomap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinitionType"},{"location":"v1/GeomapWidgetDefinitionType/#geomapwidgetdefinitiontype","text":"Type of the geomap widget.","title":"GeomapWidgetDefinitionType"},{"location":"v1/GeomapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the geomap widget. defaults to \"geomap\", must be one of [\"geomap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetDefinitionView/","text":"GeomapWidgetDefinitionView The view of the world that the map should render. Properties Name Type Description Notes focus str The 2-letter ISO code of a country to focus the map on. Or `WORLD`. [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinitionView"},{"location":"v1/GeomapWidgetDefinitionView/#geomapwidgetdefinitionview","text":"The view of the world that the map should render.","title":"GeomapWidgetDefinitionView"},{"location":"v1/GeomapWidgetDefinitionView/#properties","text":"Name Type Description Notes focus str The 2-letter ISO code of a country to focus the map on. Or `WORLD`. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetRequest/","text":"GeomapWidgetRequest An updated geomap widget. Properties Name Type Description Notes formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] q str The widget metrics query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetRequest"},{"location":"v1/GeomapWidgetRequest/#geomapwidgetrequest","text":"An updated geomap widget.","title":"GeomapWidgetRequest"},{"location":"v1/GeomapWidgetRequest/#properties","text":"Name Type Description Notes formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] q str The widget metrics query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GraphSnapshot/","text":"GraphSnapshot Object representing a graph snapshot. Properties Name Type Description Notes graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] metric_query str The metric query. One of `metric_query` or `graph_def` is required. [optional] snapshot_url str URL of your graph snapshot . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GraphSnapshot"},{"location":"v1/GraphSnapshot/#graphsnapshot","text":"Object representing a graph snapshot.","title":"GraphSnapshot"},{"location":"v1/GraphSnapshot/#properties","text":"Name Type Description Notes graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] metric_query str The metric query. One of `metric_query` or `graph_def` is required. [optional] snapshot_url str URL of your graph snapshot . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GroupWidgetDefinition/","text":"GroupWidgetDefinition The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible. Properties Name Type Description Notes layout_type WidgetLayoutType type GroupWidgetDefinitionType widgets [Widget] List of widget groups. background_color str Background color of the group title. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True title str Title of the widget. [optional] title_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GroupWidgetDefinition"},{"location":"v1/GroupWidgetDefinition/#groupwidgetdefinition","text":"The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.","title":"GroupWidgetDefinition"},{"location":"v1/GroupWidgetDefinition/#properties","text":"Name Type Description Notes layout_type WidgetLayoutType type GroupWidgetDefinitionType widgets [Widget] List of widget groups. background_color str Background color of the group title. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True title str Title of the widget. [optional] title_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GroupWidgetDefinitionType/","text":"GroupWidgetDefinitionType Type of the group widget. Properties Name Type Description Notes value str Type of the group widget. defaults to \"group\", must be one of [\"group\", ] [Back to Model list] [Back to API list] [Back to README]","title":"GroupWidgetDefinitionType"},{"location":"v1/GroupWidgetDefinitionType/#groupwidgetdefinitiontype","text":"Type of the group widget.","title":"GroupWidgetDefinitionType"},{"location":"v1/GroupWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the group widget. defaults to \"group\", must be one of [\"group\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPLog/","text":"HTTPLog Structured log message. Properties Name Type Description Notes value [HTTPLogItem] Structured log message. [Back to Model list] [Back to API list] [Back to README]","title":"HTTPLog"},{"location":"v1/HTTPLog/#httplog","text":"Structured log message.","title":"HTTPLog"},{"location":"v1/HTTPLog/#properties","text":"Name Type Description Notes value [HTTPLogItem] Structured log message. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPLogError/","text":"HTTPLogError Invalid query performed. Properties Name Type Description Notes code int Error code. message str Error message. [Back to Model list] [Back to API list] [Back to README]","title":"HTTPLogError"},{"location":"v1/HTTPLogError/#httplogerror","text":"Invalid query performed.","title":"HTTPLogError"},{"location":"v1/HTTPLogError/#properties","text":"Name Type Description Notes code int Error code. message str Error message. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPLogItem/","text":"HTTPLogItem Logs that are sent over HTTP. Properties Name Type Description Notes ddsource str 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 . [optional] ddtags str Tags associated with your logs. [optional] hostname str The name of the originating host of the log. [optional] message str The message reserved attribute 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 str 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HTTPLogItem"},{"location":"v1/HTTPLogItem/#httplogitem","text":"Logs that are sent over HTTP.","title":"HTTPLogItem"},{"location":"v1/HTTPLogItem/#properties","text":"Name Type Description Notes ddsource str 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 . [optional] ddtags str Tags associated with your logs. [optional] hostname str The name of the originating host of the log. [optional] message str The message reserved attribute 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 str 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPMethod/","text":"HTTPMethod The HTTP method. Properties Name Type Description Notes value str The HTTP method. must be one of [\"GET\", \"POST\", \"PATCH\", \"PUT\", \"DELETE\", \"HEAD\", \"OPTIONS\", ] [Back to Model list] [Back to API list] [Back to README]","title":"HTTPMethod"},{"location":"v1/HTTPMethod/#httpmethod","text":"The HTTP method.","title":"HTTPMethod"},{"location":"v1/HTTPMethod/#properties","text":"Name Type Description Notes value str The HTTP method. must be one of [\"GET\", \"POST\", \"PATCH\", \"PUT\", \"DELETE\", \"HEAD\", \"OPTIONS\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HeatMapWidgetDefinition/","text":"HeatMapWidgetDefinition The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is. Properties Name Type Description Notes requests [HeatMapWidgetRequest] List of widget types. type HeatMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] show_legend bool Whether or not to display the legend on this widget. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HeatMapWidgetDefinition"},{"location":"v1/HeatMapWidgetDefinition/#heatmapwidgetdefinition","text":"The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.","title":"HeatMapWidgetDefinition"},{"location":"v1/HeatMapWidgetDefinition/#properties","text":"Name Type Description Notes requests [HeatMapWidgetRequest] List of widget types. type HeatMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] show_legend bool Whether or not to display the legend on this widget. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HeatMapWidgetDefinitionType/","text":"HeatMapWidgetDefinitionType Type of the heat map widget. Properties Name Type Description Notes value str Type of the heat map widget. defaults to \"heatmap\", must be one of [\"heatmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"HeatMapWidgetDefinitionType"},{"location":"v1/HeatMapWidgetDefinitionType/#heatmapwidgetdefinitiontype","text":"Type of the heat map widget.","title":"HeatMapWidgetDefinitionType"},{"location":"v1/HeatMapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the heat map widget. defaults to \"heatmap\", must be one of [\"heatmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HeatMapWidgetRequest/","text":"HeatMapWidgetRequest Updated heat map widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] event_query EventQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HeatMapWidgetRequest"},{"location":"v1/HeatMapWidgetRequest/#heatmapwidgetrequest","text":"Updated heat map widget.","title":"HeatMapWidgetRequest"},{"location":"v1/HeatMapWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] event_query EventQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Host/","text":"Host Object representing a host. Properties Name Type Description Notes aliases [str] Host aliases collected by Datadog. [optional] apps [str] The Datadog integrations reporting metrics for the host. [optional] aws_name str AWS name of your host. [optional] host_name str The host name. [optional] id int The host ID. [optional] is_muted bool If a host is muted or unmuted. [optional] last_reported_time int Last time the host reported a metric data point. [optional] meta HostMeta [optional] metrics HostMetrics [optional] mute_timeout int Timeout of the mute applied to your host. [optional] name str The host name. [optional] sources [str] Source or cloud provider associated with your host. [optional] tags_by_source {str: ([str],)} List of tags for each source (AWS, Datadog Agent, Chef..). [optional] up bool Displays UP when the expected metrics are received and displays `???` if no metrics are received. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Host"},{"location":"v1/Host/#host","text":"Object representing a host.","title":"Host"},{"location":"v1/Host/#properties","text":"Name Type Description Notes aliases [str] Host aliases collected by Datadog. [optional] apps [str] The Datadog integrations reporting metrics for the host. [optional] aws_name str AWS name of your host. [optional] host_name str The host name. [optional] id int The host ID. [optional] is_muted bool If a host is muted or unmuted. [optional] last_reported_time int Last time the host reported a metric data point. [optional] meta HostMeta [optional] metrics HostMetrics [optional] mute_timeout int Timeout of the mute applied to your host. [optional] name str The host name. [optional] sources [str] Source or cloud provider associated with your host. [optional] tags_by_source {str: ([str],)} List of tags for each source (AWS, Datadog Agent, Chef..). [optional] up bool Displays UP when the expected metrics are received and displays `???` if no metrics are received. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostListResponse/","text":"HostListResponse Response with Host information from Datadog. Properties Name Type Description Notes host_list [Host] Array of hosts. [optional] total_matching int Number of host matching the query. [optional] total_returned int Number of host returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostListResponse"},{"location":"v1/HostListResponse/#hostlistresponse","text":"Response with Host information from Datadog.","title":"HostListResponse"},{"location":"v1/HostListResponse/#properties","text":"Name Type Description Notes host_list [Host] Array of hosts. [optional] total_matching int Number of host matching the query. [optional] total_returned int Number of host returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapRequest/","text":"HostMapRequest Updated host map. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapRequest"},{"location":"v1/HostMapRequest/#hostmaprequest","text":"Updated host map.","title":"HostMapRequest"},{"location":"v1/HostMapRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinition/","text":"HostMapWidgetDefinition The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. Properties Name Type Description Notes requests HostMapWidgetDefinitionRequests type HostMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] style HostMapWidgetDefinitionStyle [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinition"},{"location":"v1/HostMapWidgetDefinition/#hostmapwidgetdefinition","text":"The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.","title":"HostMapWidgetDefinition"},{"location":"v1/HostMapWidgetDefinition/#properties","text":"Name Type Description Notes requests HostMapWidgetDefinitionRequests type HostMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] style HostMapWidgetDefinitionStyle [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinitionRequests/","text":"HostMapWidgetDefinitionRequests List of definitions. Properties Name Type Description Notes fill HostMapRequest [optional] size HostMapRequest [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinitionRequests"},{"location":"v1/HostMapWidgetDefinitionRequests/#hostmapwidgetdefinitionrequests","text":"List of definitions.","title":"HostMapWidgetDefinitionRequests"},{"location":"v1/HostMapWidgetDefinitionRequests/#properties","text":"Name Type Description Notes fill HostMapRequest [optional] size HostMapRequest [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinitionStyle/","text":"HostMapWidgetDefinitionStyle The style to apply to the widget. Properties Name Type Description Notes fill_max str Max value to use to color the map. [optional] fill_min str Min value to use to color the map. [optional] palette str Color palette to apply to the widget. [optional] palette_flip bool Whether to flip the palette tones. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinitionStyle"},{"location":"v1/HostMapWidgetDefinitionStyle/#hostmapwidgetdefinitionstyle","text":"The style to apply to the widget.","title":"HostMapWidgetDefinitionStyle"},{"location":"v1/HostMapWidgetDefinitionStyle/#properties","text":"Name Type Description Notes fill_max str Max value to use to color the map. [optional] fill_min str Min value to use to color the map. [optional] palette str Color palette to apply to the widget. [optional] palette_flip bool Whether to flip the palette tones. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinitionType/","text":"HostMapWidgetDefinitionType Type of the host map widget. Properties Name Type Description Notes value str Type of the host map widget. defaults to \"hostmap\", must be one of [\"hostmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinitionType"},{"location":"v1/HostMapWidgetDefinitionType/#hostmapwidgetdefinitiontype","text":"Type of the host map widget.","title":"HostMapWidgetDefinitionType"},{"location":"v1/HostMapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the host map widget. defaults to \"hostmap\", must be one of [\"hostmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMeta/","text":"HostMeta Metadata associated with your host. Properties Name Type Description Notes nix_v [str] Array of Unix versions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMeta"},{"location":"v1/HostMeta/#hostmeta","text":"Metadata associated with your host.","title":"HostMeta"},{"location":"v1/HostMeta/#properties","text":"Name Type Description Notes nix_v [str] Array of Unix versions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMetrics/","text":"HostMetrics Host Metrics collected. Properties 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] [Back to Model list] [Back to API list] [Back to README]","title":"HostMetrics"},{"location":"v1/HostMetrics/#hostmetrics","text":"Host Metrics collected.","title":"HostMetrics"},{"location":"v1/HostMetrics/#properties","text":"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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMuteResponse/","text":"HostMuteResponse Response with the list of muted host for your organization. Properties Name Type Description Notes action str Action applied to the hosts. [optional] end int POSIX timestamp in seconds when the host is unmuted. [optional] hostname str The host name. [optional] message str Message associated with the mute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMuteResponse"},{"location":"v1/HostMuteResponse/#hostmuteresponse","text":"Response with the list of muted host for your organization.","title":"HostMuteResponse"},{"location":"v1/HostMuteResponse/#properties","text":"Name Type Description Notes action str Action applied to the hosts. [optional] end int POSIX timestamp in seconds when the host is unmuted. [optional] hostname str The host name. [optional] message str Message associated with the mute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMuteSettings/","text":"HostMuteSettings Combination of settings to mute a host. Properties Name Type Description Notes end int POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. [optional] message str Message to associate with the muting of this host. [optional] override bool If true and the host is already muted, replaces existing host mute settings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMuteSettings"},{"location":"v1/HostMuteSettings/#hostmutesettings","text":"Combination of settings to mute a host.","title":"HostMuteSettings"},{"location":"v1/HostMuteSettings/#properties","text":"Name Type Description Notes end int POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. [optional] message str Message to associate with the muting of this host. [optional] override bool If true and the host is already muted, replaces existing host mute settings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostTags/","text":"HostTags Set of tags to associate with your host. Properties Name Type Description Notes host str Your host name. [optional] tags [str] A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostTags"},{"location":"v1/HostTags/#hosttags","text":"Set of tags to associate with your host.","title":"HostTags"},{"location":"v1/HostTags/#properties","text":"Name Type Description Notes host str Your host name. [optional] tags [str] A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostTotals/","text":"HostTotals Total number of host currently monitored by Datadog. Properties Name Type Description Notes total_active int Total number of active host (UP and ???) reporting to Datadog. [optional] total_up int Number of host that are UP and reporting to Datadog. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostTotals"},{"location":"v1/HostTotals/#hosttotals","text":"Total number of host currently monitored by Datadog.","title":"HostTotals"},{"location":"v1/HostTotals/#properties","text":"Name Type Description Notes total_active int Total number of active host (UP and ???) reporting to Datadog. [optional] total_up int Number of host that are UP and reporting to Datadog. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostsApi/","text":"datadog_api_client.v1.HostsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts list_hosts GET /api/v1/hosts Get all hosts for your organization mute_host POST /api/v1/host/{host_name}/mute Mute a host unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host get_host_totals HostTotals get_host_totals() Get the total number of active hosts This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) _from = 1 # int | Number of seconds from which you want to get total number of active hosts. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the total number of active hosts api_response = api_instance.get_host_totals(_from=_from) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->get_host_totals: %s\\n\" % e) Parameters Name Type Description Notes _from int Number of seconds from which you want to get total number of active hosts. [optional] Return type HostTotals Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_hosts HostListResponse list_hosts() Get all hosts for your organization This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) filter = \"filter_example\" # str | String to filter search results. (optional) sort_field = \"sort_field_example\" # str | Sort hosts by this field. (optional) sort_dir = \"sort_dir_example\" # str | Direction of sort. Options include `asc` and `desc`. (optional) start = 1 # int | Host result to start search from. (optional) count = 1 # int | Number of hosts to return. Max 1000. (optional) _from = 1 # int | Number of seconds since UNIX epoch from which you want to search your hosts. (optional) include_muted_hosts_data = True # bool | Include information on the muted status of hosts and when the mute expires. (optional) include_hosts_metadata = True # bool | Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all hosts for your organization api_response = api_instance.list_hosts(filter=filter, sort_field=sort_field, sort_dir=sort_dir, start=start, count=count, _from=_from, include_muted_hosts_data=include_muted_hosts_data, include_hosts_metadata=include_hosts_metadata) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->list_hosts: %s\\n\" % e) Parameters Name Type Description Notes filter str String to filter search results. [optional] sort_field str Sort hosts by this field. [optional] sort_dir str Direction of sort. Options include `asc` and `desc`. [optional] start int Host result to start search from. [optional] count int Number of hosts to return. Max 1000. [optional] _from int Number of seconds since UNIX epoch from which you want to search your hosts. [optional] include_muted_hosts_data bool Include information on the muted status of hosts and when the mute expires. [optional] include_hosts_metadata bool Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). [optional] Return type HostListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] mute_host HostMuteResponse mute_host(host_name, body) Mute a host Mute a host. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to mute. body = HostMuteSettings( end=1579098130, message=\"Muting this host for a test!\", override=False, ) # HostMuteSettings | Mute a host request body. # example passing only required values which don't have defaults set try: # Mute a host api_response = api_instance.mute_host(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->mute_host: %s\\n\" % e) Parameters Name Type Description Notes host_name str Name of the host to mute. body HostMuteSettings Mute a host request body. Return type HostMuteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] unmute_host HostMuteResponse unmute_host(host_name) Unmute a host Unmutes a host. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to unmute. # example passing only required values which don't have defaults set try: # Unmute a host api_response = api_instance.unmute_host(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->unmute_host: %s\\n\" % e) Parameters Name Type Description Notes host_name str Name of the host to unmute. Return type HostMuteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.HostsApi"},{"location":"v1/HostsApi/#datadog_api_clientv1hostsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts list_hosts GET /api/v1/hosts Get all hosts for your organization mute_host POST /api/v1/host/{host_name}/mute Mute a host unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host","title":"datadog_api_client.v1.HostsApi"},{"location":"v1/HostsApi/#get_host_totals","text":"HostTotals get_host_totals() Get the total number of active hosts This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.","title":"get_host_totals"},{"location":"v1/HostsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) _from = 1 # int | Number of seconds from which you want to get total number of active hosts. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the total number of active hosts api_response = api_instance.get_host_totals(_from=_from) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->get_host_totals: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters","text":"Name Type Description Notes _from int Number of seconds from which you want to get total number of active hosts. [optional]","title":"Parameters"},{"location":"v1/HostsApi/#return-type","text":"HostTotals","title":"Return type"},{"location":"v1/HostsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/HostsApi/#list_hosts","text":"HostListResponse list_hosts() Get all hosts for your organization This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time.","title":"list_hosts"},{"location":"v1/HostsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) filter = \"filter_example\" # str | String to filter search results. (optional) sort_field = \"sort_field_example\" # str | Sort hosts by this field. (optional) sort_dir = \"sort_dir_example\" # str | Direction of sort. Options include `asc` and `desc`. (optional) start = 1 # int | Host result to start search from. (optional) count = 1 # int | Number of hosts to return. Max 1000. (optional) _from = 1 # int | Number of seconds since UNIX epoch from which you want to search your hosts. (optional) include_muted_hosts_data = True # bool | Include information on the muted status of hosts and when the mute expires. (optional) include_hosts_metadata = True # bool | Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all hosts for your organization api_response = api_instance.list_hosts(filter=filter, sort_field=sort_field, sort_dir=sort_dir, start=start, count=count, _from=_from, include_muted_hosts_data=include_muted_hosts_data, include_hosts_metadata=include_hosts_metadata) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->list_hosts: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters_1","text":"Name Type Description Notes filter str String to filter search results. [optional] sort_field str Sort hosts by this field. [optional] sort_dir str Direction of sort. Options include `asc` and `desc`. [optional] start int Host result to start search from. [optional] count int Number of hosts to return. Max 1000. [optional] _from int Number of seconds since UNIX epoch from which you want to search your hosts. [optional] include_muted_hosts_data bool Include information on the muted status of hosts and when the mute expires. [optional] include_hosts_metadata bool Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). [optional]","title":"Parameters"},{"location":"v1/HostsApi/#return-type_1","text":"HostListResponse","title":"Return type"},{"location":"v1/HostsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/HostsApi/#mute_host","text":"HostMuteResponse mute_host(host_name, body) Mute a host Mute a host.","title":"mute_host"},{"location":"v1/HostsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to mute. body = HostMuteSettings( end=1579098130, message=\"Muting this host for a test!\", override=False, ) # HostMuteSettings | Mute a host request body. # example passing only required values which don't have defaults set try: # Mute a host api_response = api_instance.mute_host(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->mute_host: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters_2","text":"Name Type Description Notes host_name str Name of the host to mute. body HostMuteSettings Mute a host request body.","title":"Parameters"},{"location":"v1/HostsApi/#return-type_2","text":"HostMuteResponse","title":"Return type"},{"location":"v1/HostsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/HostsApi/#unmute_host","text":"HostMuteResponse unmute_host(host_name) Unmute a host Unmutes a host. This endpoint takes no JSON arguments.","title":"unmute_host"},{"location":"v1/HostsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to unmute. # example passing only required values which don't have defaults set try: # Unmute a host api_response = api_instance.unmute_host(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->unmute_host: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters_3","text":"Name Type Description Notes host_name str Name of the host to unmute.","title":"Parameters"},{"location":"v1/HostsApi/#return-type_3","text":"HostMuteResponse","title":"Return type"},{"location":"v1/HostsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/IFrameWidgetDefinition/","text":"IFrameWidgetDefinition The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards. Properties Name Type Description Notes type IFrameWidgetDefinitionType url str URL of the iframe. [Back to Model list] [Back to API list] [Back to README]","title":"IFrameWidgetDefinition"},{"location":"v1/IFrameWidgetDefinition/#iframewidgetdefinition","text":"The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.","title":"IFrameWidgetDefinition"},{"location":"v1/IFrameWidgetDefinition/#properties","text":"Name Type Description Notes type IFrameWidgetDefinitionType url str URL of the iframe. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IFrameWidgetDefinitionType/","text":"IFrameWidgetDefinitionType Type of the iframe widget. Properties Name Type Description Notes value str Type of the iframe widget. defaults to \"iframe\", must be one of [\"iframe\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IFrameWidgetDefinitionType"},{"location":"v1/IFrameWidgetDefinitionType/#iframewidgetdefinitiontype","text":"Type of the iframe widget.","title":"IFrameWidgetDefinitionType"},{"location":"v1/IFrameWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the iframe widget. defaults to \"iframe\", must be one of [\"iframe\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesAPI/","text":"IPPrefixesAPI Available prefix information for the API endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesAPI"},{"location":"v1/IPPrefixesAPI/#ipprefixesapi","text":"Available prefix information for the API endpoints.","title":"IPPrefixesAPI"},{"location":"v1/IPPrefixesAPI/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesAPM/","text":"IPPrefixesAPM Available prefix information for the APM endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesAPM"},{"location":"v1/IPPrefixesAPM/#ipprefixesapm","text":"Available prefix information for the APM endpoints.","title":"IPPrefixesAPM"},{"location":"v1/IPPrefixesAPM/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesAgents/","text":"IPPrefixesAgents Available prefix information for the Agent endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesAgents"},{"location":"v1/IPPrefixesAgents/#ipprefixesagents","text":"Available prefix information for the Agent endpoints.","title":"IPPrefixesAgents"},{"location":"v1/IPPrefixesAgents/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesLogs/","text":"IPPrefixesLogs Available prefix information for the Logs endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesLogs"},{"location":"v1/IPPrefixesLogs/#ipprefixeslogs","text":"Available prefix information for the Logs endpoints.","title":"IPPrefixesLogs"},{"location":"v1/IPPrefixesLogs/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesProcess/","text":"IPPrefixesProcess Available prefix information for the Process endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesProcess"},{"location":"v1/IPPrefixesProcess/#ipprefixesprocess","text":"Available prefix information for the Process endpoints.","title":"IPPrefixesProcess"},{"location":"v1/IPPrefixesProcess/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesSynthetics/","text":"IPPrefixesSynthetics Available prefix information for the Synthetics endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv4_by_location {str: ([str],)} List of IPv4 prefixes by location. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] prefixes_ipv6_by_location {str: ([str],)} List of IPv6 prefixes by location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesSynthetics"},{"location":"v1/IPPrefixesSynthetics/#ipprefixessynthetics","text":"Available prefix information for the Synthetics endpoints.","title":"IPPrefixesSynthetics"},{"location":"v1/IPPrefixesSynthetics/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv4_by_location {str: ([str],)} List of IPv4 prefixes by location. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] prefixes_ipv6_by_location {str: ([str],)} List of IPv6 prefixes by location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesWebhooks/","text":"IPPrefixesWebhooks Available prefix information for the Webhook endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesWebhooks"},{"location":"v1/IPPrefixesWebhooks/#ipprefixeswebhooks","text":"Available prefix information for the Webhook endpoints.","title":"IPPrefixesWebhooks"},{"location":"v1/IPPrefixesWebhooks/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPRanges/","text":"IPRanges IP ranges. Properties Name Type Description Notes agents IPPrefixesAgents [optional] api IPPrefixesAPI [optional] apm IPPrefixesAPM [optional] logs IPPrefixesLogs [optional] modified str Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. [optional] process IPPrefixesProcess [optional] synthetics IPPrefixesSynthetics [optional] version int Version of the IP list. [optional] webhooks IPPrefixesWebhooks [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPRanges"},{"location":"v1/IPRanges/#ipranges","text":"IP ranges.","title":"IPRanges"},{"location":"v1/IPRanges/#properties","text":"Name Type Description Notes agents IPPrefixesAgents [optional] api IPPrefixesAPI [optional] apm IPPrefixesAPM [optional] logs IPPrefixesLogs [optional] modified str Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. [optional] process IPPrefixesProcess [optional] synthetics IPPrefixesSynthetics [optional] version int Version of the IP list. [optional] webhooks IPPrefixesWebhooks [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPRangesApi/","text":"datadog_api_client.v1.IPRangesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_ip_ranges GET / List IP Ranges get_ip_ranges IPRanges get_ip_ranges() List IP Ranges Get information about Datadog IP ranges. Example import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import ip_ranges_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient() as api_client: # Create an instance of the API class api_instance = ip_ranges_api.IPRangesApi(api_client) # example, this endpoint has no required or optional parameters try: # List IP Ranges api_response = api_instance.get_ip_ranges() pprint(api_response) except ApiException as e: print(\"Exception when calling IPRangesApi->get_ip_ranges: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type IPRanges Authorization No authorization required HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.IPRangesApi"},{"location":"v1/IPRangesApi/#datadog_api_clientv1iprangesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_ip_ranges GET / List IP Ranges","title":"datadog_api_client.v1.IPRangesApi"},{"location":"v1/IPRangesApi/#get_ip_ranges","text":"IPRanges get_ip_ranges() List IP Ranges Get information about Datadog IP ranges.","title":"get_ip_ranges"},{"location":"v1/IPRangesApi/#example","text":"import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import ip_ranges_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient() as api_client: # Create an instance of the API class api_instance = ip_ranges_api.IPRangesApi(api_client) # example, this endpoint has no required or optional parameters try: # List IP Ranges api_response = api_instance.get_ip_ranges() pprint(api_response) except ApiException as e: print(\"Exception when calling IPRangesApi->get_ip_ranges: %s\\n\" % e)","title":"Example"},{"location":"v1/IPRangesApi/#parameters","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/IPRangesApi/#return-type","text":"IPRanges","title":"Return type"},{"location":"v1/IPRangesApi/#authorization","text":"No authorization required","title":"Authorization"},{"location":"v1/IPRangesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/IPRangesApi/#http-response-details","text":"Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/IdpFormData/","text":"IdpFormData Object describing the IdP configuration. Properties Name Type Description Notes idp_file file_type The path to the XML metadata file you wish to upload. [Back to Model list] [Back to API list] [Back to README]","title":"IdpFormData"},{"location":"v1/IdpFormData/#idpformdata","text":"Object describing the IdP configuration.","title":"IdpFormData"},{"location":"v1/IdpFormData/#properties","text":"Name Type Description Notes idp_file file_type The path to the XML metadata file you wish to upload. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IdpResponse/","text":"IdpResponse The IdP response object. Properties Name Type Description Notes message str Identity provider response. [Back to Model list] [Back to API list] [Back to README]","title":"IdpResponse"},{"location":"v1/IdpResponse/#idpresponse","text":"The IdP response object.","title":"IdpResponse"},{"location":"v1/IdpResponse/#properties","text":"Name Type Description Notes message str Identity provider response. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ImageWidgetDefinition/","text":"ImageWidgetDefinition The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards. Properties Name Type Description Notes type ImageWidgetDefinitionType url str URL of the image. has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ImageWidgetDefinition"},{"location":"v1/ImageWidgetDefinition/#imagewidgetdefinition","text":"The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.","title":"ImageWidgetDefinition"},{"location":"v1/ImageWidgetDefinition/#properties","text":"Name Type Description Notes type ImageWidgetDefinitionType url str URL of the image. has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ImageWidgetDefinitionType/","text":"ImageWidgetDefinitionType Type of the image widget. Properties Name Type Description Notes value str Type of the image widget. defaults to \"image\", must be one of [\"image\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ImageWidgetDefinitionType"},{"location":"v1/ImageWidgetDefinitionType/#imagewidgetdefinitiontype","text":"Type of the image widget.","title":"ImageWidgetDefinitionType"},{"location":"v1/ImageWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the image widget. defaults to \"image\", must be one of [\"image\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IntakePayloadAccepted/","text":"IntakePayloadAccepted The payload accepted for intake. Properties Name Type Description Notes status str The status of the intake payload. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IntakePayloadAccepted"},{"location":"v1/IntakePayloadAccepted/#intakepayloadaccepted","text":"The payload accepted for intake.","title":"IntakePayloadAccepted"},{"location":"v1/IntakePayloadAccepted/#properties","text":"Name Type Description Notes status str The status of the intake payload. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/KeyManagementApi/","text":"datadog_api_client.v1.KeyManagementApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v1/api_key Create an API key create_application_key POST /api/v1/application_key Create an application key delete_api_key DELETE /api/v1/api_key/{key} Delete an API key delete_application_key DELETE /api/v1/application_key/{key} Delete an application key get_api_key GET /api/v1/api_key/{key} Get API key get_application_key GET /api/v1/application_key/{key} Get an application key list_api_keys GET /api/v1/api_key Get all API keys list_application_keys GET /api/v1/application_key Get all application keys update_api_key PUT /api/v1/api_key/{key} Edit an API key update_application_key PUT /api/v1/application_key/{key} Edit an application key create_api_key ApiKeyResponse create_api_key(body) Create an API key Creates an API key with a given name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e) Parameters Name Type Description Notes body ApiKey Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_application_key ApplicationKeyResponse create_application_key(body) Create an application key Create an application key with a given name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Create an application key api_response = api_instance.create_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_application_key: %s\\n\" % e) Parameters Name Type Description Notes body ApplicationKey Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_api_key ApiKeyResponse delete_api_key(key) Delete an API key Delete a given API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Delete an API key api_response = api_instance.delete_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific API key you are working with. Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_application_key ApplicationKeyResponse delete_application_key(key) Delete an application key Delete a given application key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Delete an application key api_response = api_instance.delete_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific APP key you are working with. Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_key ApiKeyResponse get_api_key(key) Get API key Get a given API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific API key you are working with. Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_application_key ApplicationKeyResponse get_application_key(key) Get an application key Get a given application key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Get an application key api_response = api_instance.get_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_application_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific APP key you are working with. Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_api_keys ApiKeyListResponse list_api_keys() Get all API keys Get all API keys available for your account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all API keys api_response = api_instance.list_api_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type ApiKeyListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_application_keys ApplicationKeyListResponse list_application_keys() Get all application keys Get all application keys available for your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all application keys api_response = api_instance.list_application_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type ApplicationKeyListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_api_key ApiKeyResponse update_api_key(key, body) Edit an API key Edit an API key name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific API key you are working with. body ApiKey Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_application_key ApplicationKeyResponse update_application_key(key, body) Edit an application key Edit an application key name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific APP key you are working with. body ApplicationKey Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.KeyManagementApi"},{"location":"v1/KeyManagementApi/#datadog_api_clientv1keymanagementapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v1/api_key Create an API key create_application_key POST /api/v1/application_key Create an application key delete_api_key DELETE /api/v1/api_key/{key} Delete an API key delete_application_key DELETE /api/v1/application_key/{key} Delete an application key get_api_key GET /api/v1/api_key/{key} Get API key get_application_key GET /api/v1/application_key/{key} Get an application key list_api_keys GET /api/v1/api_key Get all API keys list_application_keys GET /api/v1/application_key Get all application keys update_api_key PUT /api/v1/api_key/{key} Edit an API key update_application_key PUT /api/v1/application_key/{key} Edit an application key","title":"datadog_api_client.v1.KeyManagementApi"},{"location":"v1/KeyManagementApi/#create_api_key","text":"ApiKeyResponse create_api_key(body) Create an API key Creates an API key with a given name.","title":"create_api_key"},{"location":"v1/KeyManagementApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters","text":"Name Type Description Notes body ApiKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#create_application_key","text":"ApplicationKeyResponse create_application_key(body) Create an application key Create an application key with a given name.","title":"create_application_key"},{"location":"v1/KeyManagementApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Create an application key api_response = api_instance.create_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_1","text":"Name Type Description Notes body ApplicationKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_1","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#delete_api_key","text":"ApiKeyResponse delete_api_key(key) Delete an API key Delete a given API key.","title":"delete_api_key"},{"location":"v1/KeyManagementApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Delete an API key api_response = api_instance.delete_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_2","text":"Name Type Description Notes key str The specific API key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_2","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#delete_application_key","text":"ApplicationKeyResponse delete_application_key(key) Delete an application key Delete a given application key.","title":"delete_application_key"},{"location":"v1/KeyManagementApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Delete an application key api_response = api_instance.delete_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_3","text":"Name Type Description Notes key str The specific APP key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_3","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#get_api_key","text":"ApiKeyResponse get_api_key(key) Get API key Get a given API key.","title":"get_api_key"},{"location":"v1/KeyManagementApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_4","text":"Name Type Description Notes key str The specific API key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_4","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#get_application_key","text":"ApplicationKeyResponse get_application_key(key) Get an application key Get a given application key.","title":"get_application_key"},{"location":"v1/KeyManagementApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Get an application key api_response = api_instance.get_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_5","text":"Name Type Description Notes key str The specific APP key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_5","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#list_api_keys","text":"ApiKeyListResponse list_api_keys() Get all API keys Get all API keys available for your account.","title":"list_api_keys"},{"location":"v1/KeyManagementApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all API keys api_response = api_instance.list_api_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_6","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_6","text":"ApiKeyListResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#list_application_keys","text":"ApplicationKeyListResponse list_application_keys() Get all application keys Get all application keys available for your Datadog account.","title":"list_application_keys"},{"location":"v1/KeyManagementApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all application keys api_response = api_instance.list_application_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_7","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_7","text":"ApplicationKeyListResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#update_api_key","text":"ApiKeyResponse update_api_key(key, body) Edit an API key Edit an API key name.","title":"update_api_key"},{"location":"v1/KeyManagementApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_8","text":"Name Type Description Notes key str The specific API key you are working with. body ApiKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_8","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#update_application_key","text":"ApplicationKeyResponse update_application_key(key, body) Edit an application key Edit an application key name.","title":"update_application_key"},{"location":"v1/KeyManagementApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_9","text":"Name Type Description Notes key str The specific APP key you are working with. body ApplicationKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_9","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_9","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/Log/","text":"Log Object describing a log after being processed and stored by Datadog. Properties Name Type Description Notes content LogContent [optional] id str Unique ID of the Log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Log"},{"location":"v1/Log/#log","text":"Object describing a log after being processed and stored by Datadog.","title":"Log"},{"location":"v1/Log/#properties","text":"Name Type Description Notes content LogContent [optional] id str Unique ID of the Log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogContent/","text":"LogContent JSON object containing all log attributes and their associated values. Properties Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 [bool, date, datetime, dict, float, int, list, str, none_type] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogContent"},{"location":"v1/LogContent/#logcontent","text":"JSON object containing all log attributes and their associated values.","title":"LogContent"},{"location":"v1/LogContent/#properties","text":"Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 [bool, date, datetime, dict, float, int, list, str, none_type] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinition/","text":"LogQueryDefinition The log query. Properties Name Type Description Notes compute LogsQueryCompute [optional] group_by [LogQueryDefinitionGroupBy] List of tag prefixes to group by in the case of a cluster check. [optional] index str A coma separated-list of index names. Use \\\"*\\\" query all indexes at once. Multiple Indexes [optional] multi_compute [LogsQueryCompute] This field is mutually exclusive with `compute`. [optional] search LogQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinition"},{"location":"v1/LogQueryDefinition/#logquerydefinition","text":"The log query.","title":"LogQueryDefinition"},{"location":"v1/LogQueryDefinition/#properties","text":"Name Type Description Notes compute LogsQueryCompute [optional] group_by [LogQueryDefinitionGroupBy] List of tag prefixes to group by in the case of a cluster check. [optional] index str A coma separated-list of index names. Use \\\"*\\\" query all indexes at once. Multiple Indexes [optional] multi_compute [LogsQueryCompute] This field is mutually exclusive with `compute`. [optional] search LogQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinitionGroupBy/","text":"LogQueryDefinitionGroupBy Defined items in the group. Properties Name Type Description Notes facet str Facet name. limit int Maximum number of items in the group. [optional] sort LogQueryDefinitionGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinitionGroupBy"},{"location":"v1/LogQueryDefinitionGroupBy/#logquerydefinitiongroupby","text":"Defined items in the group.","title":"LogQueryDefinitionGroupBy"},{"location":"v1/LogQueryDefinitionGroupBy/#properties","text":"Name Type Description Notes facet str Facet name. limit int Maximum number of items in the group. [optional] sort LogQueryDefinitionGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinitionGroupBySort/","text":"LogQueryDefinitionGroupBySort Define a sorting method. Properties Name Type Description Notes aggregation str The aggregation method. order WidgetSort facet str Facet name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinitionGroupBySort"},{"location":"v1/LogQueryDefinitionGroupBySort/#logquerydefinitiongroupbysort","text":"Define a sorting method.","title":"LogQueryDefinitionGroupBySort"},{"location":"v1/LogQueryDefinitionGroupBySort/#properties","text":"Name Type Description Notes aggregation str The aggregation method. order WidgetSort facet str Facet name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinitionSearch/","text":"LogQueryDefinitionSearch The query being made on the logs. Properties Name Type Description Notes query str Search value to apply. [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinitionSearch"},{"location":"v1/LogQueryDefinitionSearch/#logquerydefinitionsearch","text":"The query being made on the logs.","title":"LogQueryDefinitionSearch"},{"location":"v1/LogQueryDefinitionSearch/#properties","text":"Name Type Description Notes query str Search value to apply. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogStreamWidgetDefinition/","text":"LogStreamWidgetDefinition The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards. Properties Name Type Description Notes type LogStreamWidgetDefinitionType columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] query str Query to filter the log stream with. [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetFieldSort [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogStreamWidgetDefinition"},{"location":"v1/LogStreamWidgetDefinition/#logstreamwidgetdefinition","text":"The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.","title":"LogStreamWidgetDefinition"},{"location":"v1/LogStreamWidgetDefinition/#properties","text":"Name Type Description Notes type LogStreamWidgetDefinitionType columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] query str Query to filter the log stream with. [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetFieldSort [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogStreamWidgetDefinitionType/","text":"LogStreamWidgetDefinitionType Type of the log stream widget. Properties Name Type Description Notes value str Type of the log stream widget. defaults to \"log_stream\", must be one of [\"log_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogStreamWidgetDefinitionType"},{"location":"v1/LogStreamWidgetDefinitionType/#logstreamwidgetdefinitiontype","text":"Type of the log stream widget.","title":"LogStreamWidgetDefinitionType"},{"location":"v1/LogStreamWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the log stream widget. defaults to \"log_stream\", must be one of [\"log_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAPIError/","text":"LogsAPIError Error returned by the Logs API Properties Name Type Description Notes code str Code identifying the error [optional] details [LogsAPIError] Additional error details [optional] message str Error message [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAPIError"},{"location":"v1/LogsAPIError/#logsapierror","text":"Error returned by the Logs API","title":"LogsAPIError"},{"location":"v1/LogsAPIError/#properties","text":"Name Type Description Notes code str Code identifying the error [optional] details [LogsAPIError] Additional error details [optional] message str Error message [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAPIErrorResponse/","text":"LogsAPIErrorResponse Response returned by the Logs API when errors occur. Properties Name Type Description Notes error LogsAPIError [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAPIErrorResponse"},{"location":"v1/LogsAPIErrorResponse/#logsapierrorresponse","text":"Response returned by the Logs API when errors occur.","title":"LogsAPIErrorResponse"},{"location":"v1/LogsAPIErrorResponse/#properties","text":"Name Type Description Notes error LogsAPIError [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsApi/","text":"datadog_api_client.v1.LogsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_logs POST /api/v1/logs-queries/list Search logs submit_log POST /v1/input Send logs list_logs LogsListResponse list_logs(body) Search logs List endpoint returns logs that match a log search query. Results are paginated . If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( index=\"retention-3,retention-15\", limit=1, query=\"service:web* AND @http.status_code:[200 TO 299]\", sort=LogsSort(\"asc\"), start_at=\"start_at_example\", time=LogsListRequestTime( _from=dateutil_parser('2020-02-02T02:02:02Z'), timezone=\"timezone_example\", to=dateutil_parser('2020-02-02T20:20:20Z'), ), ) # LogsListRequest | Logs filter # example passing only required values which don't have defaults set try: # Search logs api_response = api_instance.list_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e) Parameters Name Type Description Notes body LogsListRequest Logs filter Return type LogsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] submit_log {str: (bool, date, datetime, dict, float, int, list, str, none_type)} submit_log(body) Send logs Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - 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. 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) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = HTTPLog([ HTTPLogItem( ddsource=\"nginx\", ddtags=\"env:staging,version:5.1\", hostname=\"i-012345678\", message=\"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\", service=\"payment\", ), ]) # HTTPLog | Log to send (JSON format). content_encoding = ContentEncoding(\"gzip\") # ContentEncoding | HTTP header used to compress the media-type. (optional) ddtags = \"env:prod,user:my-user\" # str | Log tags can be passed as query parameters with `text/plain` content type. (optional) # example passing only required values which don't have defaults set try: # Send logs api_response = api_instance.submit_log(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Send logs api_response = api_instance.submit_log(body, content_encoding=content_encoding, ddtags=ddtags) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e) Parameters Name Type Description Notes body HTTPLog Log to send (JSON format). content_encoding ContentEncoding HTTP header used to compress the media-type. [optional] ddtags str Log tags can be passed as query parameters with `text/plain` content type. [optional] Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth HTTP request headers Content-Type : application/json, application/logplex-1, text/plain Accept : application/json HTTP response details Status code Description Response headers 200 Response from server (always 200 empty JSON). - 400 unexpected error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.LogsApi"},{"location":"v1/LogsApi/#datadog_api_clientv1logsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_logs POST /api/v1/logs-queries/list Search logs submit_log POST /v1/input Send logs","title":"datadog_api_client.v1.LogsApi"},{"location":"v1/LogsApi/#list_logs","text":"LogsListResponse list_logs(body) Search logs List endpoint returns logs that match a log search query. Results are paginated . If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives","title":"list_logs"},{"location":"v1/LogsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( index=\"retention-3,retention-15\", limit=1, query=\"service:web* AND @http.status_code:[200 TO 299]\", sort=LogsSort(\"asc\"), start_at=\"start_at_example\", time=LogsListRequestTime( _from=dateutil_parser('2020-02-02T02:02:02Z'), timezone=\"timezone_example\", to=dateutil_parser('2020-02-02T20:20:20Z'), ), ) # LogsListRequest | Logs filter # example passing only required values which don't have defaults set try: # Search logs api_response = api_instance.list_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsApi/#parameters","text":"Name Type Description Notes body LogsListRequest Logs filter","title":"Parameters"},{"location":"v1/LogsApi/#return-type","text":"LogsListResponse","title":"Return type"},{"location":"v1/LogsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsApi/#submit_log","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} submit_log(body) Send logs Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - 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. 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) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time","title":"submit_log"},{"location":"v1/LogsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = HTTPLog([ HTTPLogItem( ddsource=\"nginx\", ddtags=\"env:staging,version:5.1\", hostname=\"i-012345678\", message=\"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\", service=\"payment\", ), ]) # HTTPLog | Log to send (JSON format). content_encoding = ContentEncoding(\"gzip\") # ContentEncoding | HTTP header used to compress the media-type. (optional) ddtags = \"env:prod,user:my-user\" # str | Log tags can be passed as query parameters with `text/plain` content type. (optional) # example passing only required values which don't have defaults set try: # Send logs api_response = api_instance.submit_log(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Send logs api_response = api_instance.submit_log(body, content_encoding=content_encoding, ddtags=ddtags) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsApi/#parameters_1","text":"Name Type Description Notes body HTTPLog Log to send (JSON format). content_encoding ContentEncoding HTTP header used to compress the media-type. [optional] ddtags str Log tags can be passed as query parameters with `text/plain` content type. [optional]","title":"Parameters"},{"location":"v1/LogsApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/LogsApi/#authorization_1","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/LogsApi/#http-request-headers_1","text":"Content-Type : application/json, application/logplex-1, text/plain Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsApi/#http-response-details_1","text":"Status code Description Response headers 200 Response from server (always 200 empty JSON). - 400 unexpected error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsArithmeticProcessor/","text":"LogsArithmeticProcessor Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators - , + , * , / . By default, the calculation is skipped if an attribute is missing. Select \u201cReplace missing attribute by 0\u201d to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. Notes : - The operator - needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is 0.1234567891 , the actual value stored for the attribute is 0.123456789 . - If you need to scale a unit of measure, see Scale Filter . Properties Name Type Description Notes expression str Arithmetic operation between one or more log attributes. target str Name of the attribute that contains the result of the arithmetic operation. type LogsArithmeticProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArithmeticProcessor"},{"location":"v1/LogsArithmeticProcessor/#logsarithmeticprocessor","text":"Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators - , + , * , / . By default, the calculation is skipped if an attribute is missing. Select \u201cReplace missing attribute by 0\u201d to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. Notes : - The operator - needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is 0.1234567891 , the actual value stored for the attribute is 0.123456789 . - If you need to scale a unit of measure, see Scale Filter .","title":"LogsArithmeticProcessor"},{"location":"v1/LogsArithmeticProcessor/#properties","text":"Name Type Description Notes expression str Arithmetic operation between one or more log attributes. target str Name of the attribute that contains the result of the arithmetic operation. type LogsArithmeticProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsArithmeticProcessorType/","text":"LogsArithmeticProcessorType Type of logs arithmetic processor. Properties Name Type Description Notes value str Type of logs arithmetic processor. defaults to \"arithmetic-processor\", must be one of [\"arithmetic-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArithmeticProcessorType"},{"location":"v1/LogsArithmeticProcessorType/#logsarithmeticprocessortype","text":"Type of logs arithmetic processor.","title":"LogsArithmeticProcessorType"},{"location":"v1/LogsArithmeticProcessorType/#properties","text":"Name Type Description Notes value str Type of logs arithmetic processor. defaults to \"arithmetic-processor\", must be one of [\"arithmetic-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAttributeRemapper/","text":"LogsAttributeRemapper The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the Tag Best Practice documentation . Some additional constraints are applied as : or , are not allowed in the target tag/attribute name. Properties Name Type Description Notes sources [str] Array of source attributes. target str Final attribute or tag name to remap the sources to. type LogsAttributeRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsAttributeRemapper"},{"location":"v1/LogsAttributeRemapper/#logsattributeremapper","text":"The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the Tag Best Practice documentation . Some additional constraints are applied as : or , are not allowed in the target tag/attribute name.","title":"LogsAttributeRemapper"},{"location":"v1/LogsAttributeRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. target str Final attribute or tag name to remap the sources to. type LogsAttributeRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAttributeRemapperType/","text":"LogsAttributeRemapperType Type of logs attribute remapper. Properties Name Type Description Notes value str Type of logs attribute remapper. defaults to \"attribute-remapper\", must be one of [\"attribute-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAttributeRemapperType"},{"location":"v1/LogsAttributeRemapperType/#logsattributeremappertype","text":"Type of logs attribute remapper.","title":"LogsAttributeRemapperType"},{"location":"v1/LogsAttributeRemapperType/#properties","text":"Name Type Description Notes value str Type of logs attribute remapper. defaults to \"attribute-remapper\", must be one of [\"attribute-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetention/","text":"LogsByRetention Object containing logs usage data broken down by retention period. Properties Name Type Description Notes orgs LogsByRetentionOrgs [optional] usage [LogsRetentionAggSumUsage] Aggregated index logs usage for each retention period with usage. [optional] usage_by_month LogsByRetentionMonthlyUsage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetention"},{"location":"v1/LogsByRetention/#logsbyretention","text":"Object containing logs usage data broken down by retention period.","title":"LogsByRetention"},{"location":"v1/LogsByRetention/#properties","text":"Name Type Description Notes orgs LogsByRetentionOrgs [optional] usage [LogsRetentionAggSumUsage] Aggregated index logs usage for each retention period with usage. [optional] usage_by_month LogsByRetentionMonthlyUsage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetentionMonthlyUsage/","text":"LogsByRetentionMonthlyUsage Object containing a summary of indexed logs usage by retention period for a single month. Properties Name Type Description Notes date str The month for the usage. [optional] usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the month. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetentionMonthlyUsage"},{"location":"v1/LogsByRetentionMonthlyUsage/#logsbyretentionmonthlyusage","text":"Object containing a summary of indexed logs usage by retention period for a single month.","title":"LogsByRetentionMonthlyUsage"},{"location":"v1/LogsByRetentionMonthlyUsage/#properties","text":"Name Type Description Notes date str The month for the usage. [optional] usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the month. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetentionOrgUsage/","text":"LogsByRetentionOrgUsage Indexed logs usage by retention for a single organization. Properties Name Type Description Notes usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetentionOrgUsage"},{"location":"v1/LogsByRetentionOrgUsage/#logsbyretentionorgusage","text":"Indexed logs usage by retention for a single organization.","title":"LogsByRetentionOrgUsage"},{"location":"v1/LogsByRetentionOrgUsage/#properties","text":"Name Type Description Notes usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetentionOrgs/","text":"LogsByRetentionOrgs Indexed logs usage summary for each organization for each retention period with usage. Properties Name Type Description Notes usage [LogsByRetentionOrgUsage] Indexed logs usage summary for each organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetentionOrgs"},{"location":"v1/LogsByRetentionOrgs/#logsbyretentionorgs","text":"Indexed logs usage summary for each organization for each retention period with usage.","title":"LogsByRetentionOrgs"},{"location":"v1/LogsByRetentionOrgs/#properties","text":"Name Type Description Notes usage [LogsByRetentionOrgUsage] Indexed logs usage summary for each organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsCategoryProcessor/","text":"LogsCategoryProcessor Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes : - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper. Properties Name Type Description Notes categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. target str Name of the target attribute which value is defined by the matching category. type LogsCategoryProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCategoryProcessor"},{"location":"v1/LogsCategoryProcessor/#logscategoryprocessor","text":"Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes : - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper.","title":"LogsCategoryProcessor"},{"location":"v1/LogsCategoryProcessor/#properties","text":"Name Type Description Notes categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. target str Name of the target attribute which value is defined by the matching category. type LogsCategoryProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsCategoryProcessorCategory/","text":"LogsCategoryProcessorCategory Object describing the logs filter. Properties Name Type Description Notes filter LogsFilter [optional] name str Value to assign to the target attribute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCategoryProcessorCategory"},{"location":"v1/LogsCategoryProcessorCategory/#logscategoryprocessorcategory","text":"Object describing the logs filter.","title":"LogsCategoryProcessorCategory"},{"location":"v1/LogsCategoryProcessorCategory/#properties","text":"Name Type Description Notes filter LogsFilter [optional] name str Value to assign to the target attribute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsCategoryProcessorType/","text":"LogsCategoryProcessorType Type of logs category processor. Properties Name Type Description Notes value str Type of logs category processor. defaults to \"category-processor\", must be one of [\"category-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCategoryProcessorType"},{"location":"v1/LogsCategoryProcessorType/#logscategoryprocessortype","text":"Type of logs category processor.","title":"LogsCategoryProcessorType"},{"location":"v1/LogsCategoryProcessorType/#properties","text":"Name Type Description Notes value str Type of logs category processor. defaults to \"category-processor\", must be one of [\"category-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsDateRemapper/","text":"LogsDateRemapper As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - timestamp - date - _timestamp - Timestamp - eventTime - published_date If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. Note: If your logs don\u2019t contain any of the default attributes and you haven\u2019t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. Properties Name Type Description Notes sources [str] Array of source attributes. type LogsDateRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsDateRemapper"},{"location":"v1/LogsDateRemapper/#logsdateremapper","text":"As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - timestamp - date - _timestamp - Timestamp - eventTime - published_date If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. Note: If your logs don\u2019t contain any of the default attributes and you haven\u2019t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.","title":"LogsDateRemapper"},{"location":"v1/LogsDateRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. type LogsDateRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsDateRemapperType/","text":"LogsDateRemapperType Type of logs date remapper. Properties Name Type Description Notes value str Type of logs date remapper. defaults to \"date-remapper\", must be one of [\"date-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsDateRemapperType"},{"location":"v1/LogsDateRemapperType/#logsdateremappertype","text":"Type of logs date remapper.","title":"LogsDateRemapperType"},{"location":"v1/LogsDateRemapperType/#properties","text":"Name Type Description Notes value str Type of logs date remapper. defaults to \"date-remapper\", must be one of [\"date-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsExclusion/","text":"LogsExclusion Represents the index exclusion filter object from configuration API. Properties Name Type Description Notes name str Name of the index exclusion filter. filter LogsExclusionFilter [optional] is_enabled bool Whether or not the exclusion filter is active. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsExclusion"},{"location":"v1/LogsExclusion/#logsexclusion","text":"Represents the index exclusion filter object from configuration API.","title":"LogsExclusion"},{"location":"v1/LogsExclusion/#properties","text":"Name Type Description Notes name str Name of the index exclusion filter. filter LogsExclusionFilter [optional] is_enabled bool Whether or not the exclusion filter is active. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsExclusionFilter/","text":"LogsExclusionFilter Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle. Properties Name Type Description Notes sample_rate float Sample rate to apply to logs going through this exclusion filter, a value of 1 will exclude all logs matching the query. query str 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsExclusionFilter"},{"location":"v1/LogsExclusionFilter/#logsexclusionfilter","text":"Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.","title":"LogsExclusionFilter"},{"location":"v1/LogsExclusionFilter/#properties","text":"Name Type Description Notes sample_rate float Sample rate to apply to logs going through this exclusion filter, a value of 1 will exclude all logs matching the query. query str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsFilter/","text":"LogsFilter Filter for logs. Properties Name Type Description Notes query str The filter query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsFilter"},{"location":"v1/LogsFilter/#logsfilter","text":"Filter for logs.","title":"LogsFilter"},{"location":"v1/LogsFilter/#properties","text":"Name Type Description Notes query str The filter query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGeoIPParser/","text":"LogsGeoIPParser The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path. Properties Name Type Description Notes type LogsGeoIPParserType sources [str] Array of source attributes. defaults to [\"network.client.ip\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"network.client.geoip\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGeoIPParser"},{"location":"v1/LogsGeoIPParser/#logsgeoipparser","text":"The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path.","title":"LogsGeoIPParser"},{"location":"v1/LogsGeoIPParser/#properties","text":"Name Type Description Notes type LogsGeoIPParserType sources [str] Array of source attributes. defaults to [\"network.client.ip\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"network.client.geoip\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGeoIPParserType/","text":"LogsGeoIPParserType Type of GeoIP parser. Properties Name Type Description Notes value str Type of GeoIP parser. defaults to \"geo-ip-parser\", must be one of [\"geo-ip-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGeoIPParserType"},{"location":"v1/LogsGeoIPParserType/#logsgeoipparsertype","text":"Type of GeoIP parser.","title":"LogsGeoIPParserType"},{"location":"v1/LogsGeoIPParserType/#properties","text":"Name Type Description Notes value str Type of GeoIP parser. defaults to \"geo-ip-parser\", must be one of [\"geo-ip-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGrokParser/","text":"LogsGrokParser Create custom grok rules to parse the full message or a specific attribute of your raw event . For more information, see the parsing section . Properties Name Type Description Notes grok LogsGrokParserRules type LogsGrokParserType source str Name of the log attribute to parse. defaults to \"message\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGrokParser"},{"location":"v1/LogsGrokParser/#logsgrokparser","text":"Create custom grok rules to parse the full message or a specific attribute of your raw event . For more information, see the parsing section .","title":"LogsGrokParser"},{"location":"v1/LogsGrokParser/#properties","text":"Name Type Description Notes grok LogsGrokParserRules type LogsGrokParserType source str Name of the log attribute to parse. defaults to \"message\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGrokParserRules/","text":"LogsGrokParserRules Set of rules for the grok parser. Properties Name Type Description Notes match_rules str List of match rules for the grok parser, separated by a new line. support_rules str List of support rules for the grok parser, separated by a new line. [optional] if omitted the server will use the default value of \"\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsGrokParserRules"},{"location":"v1/LogsGrokParserRules/#logsgrokparserrules","text":"Set of rules for the grok parser.","title":"LogsGrokParserRules"},{"location":"v1/LogsGrokParserRules/#properties","text":"Name Type Description Notes match_rules str List of match rules for the grok parser, separated by a new line. support_rules str List of support rules for the grok parser, separated by a new line. [optional] if omitted the server will use the default value of \"\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGrokParserType/","text":"LogsGrokParserType Type of logs grok parser. Properties Name Type Description Notes value str Type of logs grok parser. defaults to \"grok-parser\", must be one of [\"grok-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGrokParserType"},{"location":"v1/LogsGrokParserType/#logsgrokparsertype","text":"Type of logs grok parser.","title":"LogsGrokParserType"},{"location":"v1/LogsGrokParserType/#properties","text":"Name Type Description Notes value str Type of logs grok parser. defaults to \"grok-parser\", must be one of [\"grok-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndex/","text":"LogsIndex Object describing a Datadog Log index. Properties Name Type Description Notes filter LogsFilter name str The name of the index. daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] exclusion_filters [LogsExclusion] 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] is_rate_limited bool 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 num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndex"},{"location":"v1/LogsIndex/#logsindex","text":"Object describing a Datadog Log index.","title":"LogsIndex"},{"location":"v1/LogsIndex/#properties","text":"Name Type Description Notes filter LogsFilter name str The name of the index. daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] exclusion_filters [LogsExclusion] 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] is_rate_limited bool 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 num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndexListResponse/","text":"LogsIndexListResponse Object with all Index configurations for a given organization. Properties Name Type Description Notes indexes [LogsIndex] Array of Log index configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndexListResponse"},{"location":"v1/LogsIndexListResponse/#logsindexlistresponse","text":"Object with all Index configurations for a given organization.","title":"LogsIndexListResponse"},{"location":"v1/LogsIndexListResponse/#properties","text":"Name Type Description Notes indexes [LogsIndex] Array of Log index configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndexUpdateRequest/","text":"LogsIndexUpdateRequest Object for updating a Datadog Log index. Properties Name Type Description Notes filter LogsFilter daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] disable_daily_limit bool 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 [LogsExclusion] 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] num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndexUpdateRequest"},{"location":"v1/LogsIndexUpdateRequest/#logsindexupdaterequest","text":"Object for updating a Datadog Log index.","title":"LogsIndexUpdateRequest"},{"location":"v1/LogsIndexUpdateRequest/#properties","text":"Name Type Description Notes filter LogsFilter daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] disable_daily_limit bool 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 [LogsExclusion] 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] num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndexesApi/","text":"datadog_api_client.v1.LogsIndexesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_index POST /api/v1/logs/config/indexes Create an index get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order list_log_indexes GET /api/v1/logs/config/indexes Get all indexes update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order create_logs_index LogsIndex create_logs_index(body) Create an index Creates a new index. Returns the Index object passed in the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndex( daily_limit=300000000, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), is_rate_limited=False, name=\"main\", num_retention_days=15, ) # LogsIndex | Object containing the new index. # example passing only required values which don't have defaults set try: # Create an index api_response = api_instance.create_logs_index(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->create_logs_index: %s\\n\" % e) Parameters Name Type Description Notes body LogsIndex Object containing the new index. Return type LogsIndex Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_index LogsIndex get_logs_index(name) Get an index Get one log index from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. # example passing only required values which don't have defaults set try: # Get an index api_response = api_instance.get_logs_index(name) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index: %s\\n\" % e) Parameters Name Type Description Notes name str Name of the log index. Return type LogsIndex Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_index_order LogsIndexesOrder get_logs_index_order() Get indexes order Get the current order of your log indexes. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get indexes order api_response = api_instance.get_logs_index_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index_order: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsIndexesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_log_indexes LogsIndexListResponse list_log_indexes() Get all indexes The Index object describes the configuration of a log index. This endpoint returns an array of the LogIndex objects of your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all indexes api_response = api_instance.list_log_indexes() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->list_log_indexes: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsIndexListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_index LogsIndex update_logs_index(name, body) Update an index Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful. Using the PUT method updates your index\u2019s configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. body = LogsIndexUpdateRequest( daily_limit=1, disable_daily_limit=True, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), num_retention_days=1, ) # LogsIndexUpdateRequest | Object containing the new `LogsIndexUpdateRequest`. # example passing only required values which don't have defaults set try: # Update an index api_response = api_instance.update_logs_index(name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index: %s\\n\" % e) Parameters Name Type Description Notes name str Name of the log index. body LogsIndexUpdateRequest Object containing the new `LogsIndexUpdateRequest`. Return type LogsIndex Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_index_order LogsIndexesOrder update_logs_index_order(body) Update indexes order This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndexesOrder( index_names=[\"main\",\"payments\",\"web\"], ) # LogsIndexesOrder | Object containing the new ordered list of index names # example passing only required values which don't have defaults set try: # Update indexes order api_response = api_instance.update_logs_index_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index_order: %s\\n\" % e) Parameters Name Type Description Notes body LogsIndexesOrder Object containing the new ordered list of index names Return type LogsIndexesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.LogsIndexesApi"},{"location":"v1/LogsIndexesApi/#datadog_api_clientv1logsindexesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_index POST /api/v1/logs/config/indexes Create an index get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order list_log_indexes GET /api/v1/logs/config/indexes Get all indexes update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order","title":"datadog_api_client.v1.LogsIndexesApi"},{"location":"v1/LogsIndexesApi/#create_logs_index","text":"LogsIndex create_logs_index(body) Create an index Creates a new index. Returns the Index object passed in the request body when the request is successful.","title":"create_logs_index"},{"location":"v1/LogsIndexesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndex( daily_limit=300000000, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), is_rate_limited=False, name=\"main\", num_retention_days=15, ) # LogsIndex | Object containing the new index. # example passing only required values which don't have defaults set try: # Create an index api_response = api_instance.create_logs_index(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->create_logs_index: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters","text":"Name Type Description Notes body LogsIndex Object containing the new index.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type","text":"LogsIndex","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#get_logs_index","text":"LogsIndex get_logs_index(name) Get an index Get one log index from your organization. This endpoint takes no JSON arguments.","title":"get_logs_index"},{"location":"v1/LogsIndexesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. # example passing only required values which don't have defaults set try: # Get an index api_response = api_instance.get_logs_index(name) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_1","text":"Name Type Description Notes name str Name of the log index.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_1","text":"LogsIndex","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#get_logs_index_order","text":"LogsIndexesOrder get_logs_index_order() Get indexes order Get the current order of your log indexes. This endpoint takes no JSON arguments.","title":"get_logs_index_order"},{"location":"v1/LogsIndexesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get indexes order api_response = api_instance.get_logs_index_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_2","text":"LogsIndexesOrder","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#list_log_indexes","text":"LogsIndexListResponse list_log_indexes() Get all indexes The Index object describes the configuration of a log index. This endpoint returns an array of the LogIndex objects of your organization.","title":"list_log_indexes"},{"location":"v1/LogsIndexesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all indexes api_response = api_instance.list_log_indexes() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->list_log_indexes: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_3","text":"LogsIndexListResponse","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#update_logs_index","text":"LogsIndex update_logs_index(name, body) Update an index Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful. Using the PUT method updates your index\u2019s configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"update_logs_index"},{"location":"v1/LogsIndexesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. body = LogsIndexUpdateRequest( daily_limit=1, disable_daily_limit=True, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), num_retention_days=1, ) # LogsIndexUpdateRequest | Object containing the new `LogsIndexUpdateRequest`. # example passing only required values which don't have defaults set try: # Update an index api_response = api_instance.update_logs_index(name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_4","text":"Name Type Description Notes name str Name of the log index. body LogsIndexUpdateRequest Object containing the new `LogsIndexUpdateRequest`.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_4","text":"LogsIndex","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#update_logs_index_order","text":"LogsIndexesOrder update_logs_index_order(body) Update indexes order This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful.","title":"update_logs_index_order"},{"location":"v1/LogsIndexesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndexesOrder( index_names=[\"main\",\"payments\",\"web\"], ) # LogsIndexesOrder | Object containing the new ordered list of index names # example passing only required values which don't have defaults set try: # Update indexes order api_response = api_instance.update_logs_index_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_5","text":"Name Type Description Notes body LogsIndexesOrder Object containing the new ordered list of index names","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_5","text":"LogsIndexesOrder","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesOrder/","text":"LogsIndexesOrder Object containing the ordered list of log index names. Properties Name Type Description Notes index_names [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndexesOrder"},{"location":"v1/LogsIndexesOrder/#logsindexesorder","text":"Object containing the ordered list of log index names.","title":"LogsIndexesOrder"},{"location":"v1/LogsIndexesOrder/#properties","text":"Name Type Description Notes index_names [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsListRequest/","text":"LogsListRequest Object to send with the request to retrieve a list of logs from your Organization. Properties Name Type Description Notes time LogsListRequestTime index str 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 int Number of logs return in the response. [optional] query str The search query - following the log search syntax. [optional] sort LogsSort [optional] start_at str 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequest"},{"location":"v1/LogsListRequest/#logslistrequest","text":"Object to send with the request to retrieve a list of logs from your Organization.","title":"LogsListRequest"},{"location":"v1/LogsListRequest/#properties","text":"Name Type Description Notes time LogsListRequestTime index str 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 int Number of logs return in the response. [optional] query str The search query - following the log search syntax. [optional] sort LogsSort [optional] start_at str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsListRequestTime/","text":"LogsListRequestTime Timeframe to retrieve the log from. Properties Name Type Description Notes _from datetime Minimum timestamp for requested logs. to datetime Maximum timestamp for requested logs. timezone str Timezone can be specified both as an offset (e.g. \\\"UTC+03:00\\\") or a regional zone (e.g. \\\"Europe/Paris\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequestTime"},{"location":"v1/LogsListRequestTime/#logslistrequesttime","text":"Timeframe to retrieve the log from.","title":"LogsListRequestTime"},{"location":"v1/LogsListRequestTime/#properties","text":"Name Type Description Notes _from datetime Minimum timestamp for requested logs. to datetime Maximum timestamp for requested logs. timezone str Timezone can be specified both as an offset (e.g. \\\"UTC+03:00\\\") or a regional zone (e.g. \\\"Europe/Paris\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsListResponse/","text":"LogsListResponse Response object with all logs matching the request and pagination information. Properties Name Type Description Notes logs [Log] Array of logs matching the request and the `nextLogId` if sent. [optional] next_log_id str Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. [optional] status str Status of the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListResponse"},{"location":"v1/LogsListResponse/#logslistresponse","text":"Response object with all logs matching the request and pagination information.","title":"LogsListResponse"},{"location":"v1/LogsListResponse/#properties","text":"Name Type Description Notes logs [Log] Array of logs matching the request and the `nextLogId` if sent. [optional] next_log_id str Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. [optional] status str Status of the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsLookupProcessor/","text":"LogsLookupProcessor Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines. Properties Name Type Description Notes lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` source str Source attribute used to perform the lookup. target str 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 default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsLookupProcessor"},{"location":"v1/LogsLookupProcessor/#logslookupprocessor","text":"Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines.","title":"LogsLookupProcessor"},{"location":"v1/LogsLookupProcessor/#properties","text":"Name Type Description Notes lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` source str Source attribute used to perform the lookup. target str 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 default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsLookupProcessorType/","text":"LogsLookupProcessorType Type of logs lookup processor. Properties Name Type Description Notes value str Type of logs lookup processor. defaults to \"lookup-processor\", must be one of [\"lookup-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsLookupProcessorType"},{"location":"v1/LogsLookupProcessorType/#logslookupprocessortype","text":"Type of logs lookup processor.","title":"LogsLookupProcessorType"},{"location":"v1/LogsLookupProcessorType/#properties","text":"Name Type Description Notes value str Type of logs lookup processor. defaults to \"lookup-processor\", must be one of [\"lookup-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsMessageRemapper/","text":"LogsMessageRemapper The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. Note: If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. Properties Name Type Description Notes type LogsMessageRemapperType sources [str] Array of source attributes. defaults to [\"msg\"] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMessageRemapper"},{"location":"v1/LogsMessageRemapper/#logsmessageremapper","text":"The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. Note: If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.","title":"LogsMessageRemapper"},{"location":"v1/LogsMessageRemapper/#properties","text":"Name Type Description Notes type LogsMessageRemapperType sources [str] Array of source attributes. defaults to [\"msg\"] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsMessageRemapperType/","text":"LogsMessageRemapperType Type of logs message remapper. Properties Name Type Description Notes value str Type of logs message remapper. defaults to \"message-remapper\", must be one of [\"message-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMessageRemapperType"},{"location":"v1/LogsMessageRemapperType/#logsmessageremappertype","text":"Type of logs message remapper.","title":"LogsMessageRemapperType"},{"location":"v1/LogsMessageRemapperType/#properties","text":"Name Type Description Notes value str Type of logs message remapper. defaults to \"message-remapper\", must be one of [\"message-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipeline/","text":"LogsPipeline Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note : These endpoints are only available for admin users. Make sure to use an application key created by an admin. Properties Name Type Description Notes name str Name of the pipeline. filter LogsFilter [optional] id str ID of the pipeline. optional is_enabled bool Whether or not the pipeline is enabled. [optional] is_read_only bool Whether or not the pipeline can be edited. optional processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] type str Type of pipeline. optional [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipeline"},{"location":"v1/LogsPipeline/#logspipeline","text":"Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note : These endpoints are only available for admin users. Make sure to use an application key created by an admin.","title":"LogsPipeline"},{"location":"v1/LogsPipeline/#properties","text":"Name Type Description Notes name str Name of the pipeline. filter LogsFilter [optional] id str ID of the pipeline. optional is_enabled bool Whether or not the pipeline is enabled. [optional] is_read_only bool Whether or not the pipeline can be edited. optional processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] type str Type of pipeline. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelineList/","text":"LogsPipelineList Array of pipeline ID strings. Properties Name Type Description Notes value [LogsPipeline] Array of pipeline ID strings. [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelineList"},{"location":"v1/LogsPipelineList/#logspipelinelist","text":"Array of pipeline ID strings.","title":"LogsPipelineList"},{"location":"v1/LogsPipelineList/#properties","text":"Name Type Description Notes value [LogsPipeline] Array of pipeline ID strings. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelineProcessor/","text":"LogsPipelineProcessor Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors. Properties Name Type Description Notes type LogsPipelineProcessorType filter LogsFilter [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelineProcessor"},{"location":"v1/LogsPipelineProcessor/#logspipelineprocessor","text":"Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors.","title":"LogsPipelineProcessor"},{"location":"v1/LogsPipelineProcessor/#properties","text":"Name Type Description Notes type LogsPipelineProcessorType filter LogsFilter [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelineProcessorType/","text":"LogsPipelineProcessorType Type of logs pipeline processor. Properties Name Type Description Notes value str Type of logs pipeline processor. defaults to \"pipeline\", must be one of [\"pipeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelineProcessorType"},{"location":"v1/LogsPipelineProcessorType/#logspipelineprocessortype","text":"Type of logs pipeline processor.","title":"LogsPipelineProcessorType"},{"location":"v1/LogsPipelineProcessorType/#properties","text":"Name Type Description Notes value str Type of logs pipeline processor. defaults to \"pipeline\", must be one of [\"pipeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelinesApi/","text":"datadog_api_client.v1.LogsPipelinesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order create_logs_pipeline LogsPipeline create_logs_pipeline(body) Create a pipeline Create a pipeline in your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | Definition of the new pipeline. # example passing only required values which don't have defaults set try: # Create a pipeline api_response = api_instance.create_logs_pipeline(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->create_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes body LogsPipeline Definition of the new pipeline. Return type LogsPipeline Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_logs_pipeline delete_logs_pipeline(pipeline_id) Delete a pipeline Delete a given pipeline from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. # example passing only required values which don't have defaults set try: # Delete a pipeline api_instance.delete_logs_pipeline(pipeline_id) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->delete_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes pipeline_id str ID of the pipeline to delete. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_pipeline LogsPipeline get_logs_pipeline(pipeline_id) Get a pipeline Get a specific pipeline from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to get. # example passing only required values which don't have defaults set try: # Get a pipeline api_response = api_instance.get_logs_pipeline(pipeline_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes pipeline_id str ID of the pipeline to get. Return type LogsPipeline Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_pipeline_order LogsPipelinesOrder get_logs_pipeline_order() Get pipeline order Get the current order of your pipelines. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get pipeline order api_response = api_instance.get_logs_pipeline_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline_order: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsPipelinesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_pipelines LogsPipelineList list_logs_pipelines() Get all pipelines Get all pipelines from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all pipelines api_response = api_instance.list_logs_pipelines() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->list_logs_pipelines: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsPipelineList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_pipeline LogsPipeline update_logs_pipeline(pipeline_id, body) Update a pipeline Update a given pipeline configuration to change it\u2019s processors or their order. Note : Using this method updates your pipeline configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | New definition of the pipeline. # example passing only required values which don't have defaults set try: # Update a pipeline api_response = api_instance.update_logs_pipeline(pipeline_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes pipeline_id str ID of the pipeline to delete. body LogsPipeline New definition of the pipeline. Return type LogsPipeline Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_pipeline_order LogsPipelinesOrder update_logs_pipeline_order(body) Update pipeline order Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors. Note : Using the PUT method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipelinesOrder( pipeline_ids=[\"tags\",\"org_ids\",\"products\"], ) # LogsPipelinesOrder | Object containing the new ordered list of pipeline IDs. # example passing only required values which don't have defaults set try: # Update pipeline order api_response = api_instance.update_logs_pipeline_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline_order: %s\\n\" % e) Parameters Name Type Description Notes body LogsPipelinesOrder Object containing the new ordered list of pipeline IDs. Return type LogsPipelinesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.LogsPipelinesApi"},{"location":"v1/LogsPipelinesApi/#datadog_api_clientv1logspipelinesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order","title":"datadog_api_client.v1.LogsPipelinesApi"},{"location":"v1/LogsPipelinesApi/#create_logs_pipeline","text":"LogsPipeline create_logs_pipeline(body) Create a pipeline Create a pipeline in your organization.","title":"create_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | Definition of the new pipeline. # example passing only required values which don't have defaults set try: # Create a pipeline api_response = api_instance.create_logs_pipeline(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->create_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters","text":"Name Type Description Notes body LogsPipeline Definition of the new pipeline.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type","text":"LogsPipeline","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#delete_logs_pipeline","text":"delete_logs_pipeline(pipeline_id) Delete a pipeline Delete a given pipeline from your organization. This endpoint takes no JSON arguments.","title":"delete_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. # example passing only required values which don't have defaults set try: # Delete a pipeline api_instance.delete_logs_pipeline(pipeline_id) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->delete_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_1","text":"Name Type Description Notes pipeline_id str ID of the pipeline to delete.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#get_logs_pipeline","text":"LogsPipeline get_logs_pipeline(pipeline_id) Get a pipeline Get a specific pipeline from your organization. This endpoint takes no JSON arguments.","title":"get_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to get. # example passing only required values which don't have defaults set try: # Get a pipeline api_response = api_instance.get_logs_pipeline(pipeline_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_2","text":"Name Type Description Notes pipeline_id str ID of the pipeline to get.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_2","text":"LogsPipeline","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#get_logs_pipeline_order","text":"LogsPipelinesOrder get_logs_pipeline_order() Get pipeline order Get the current order of your pipelines. This endpoint takes no JSON arguments.","title":"get_logs_pipeline_order"},{"location":"v1/LogsPipelinesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get pipeline order api_response = api_instance.get_logs_pipeline_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_3","text":"LogsPipelinesOrder","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#list_logs_pipelines","text":"LogsPipelineList list_logs_pipelines() Get all pipelines Get all pipelines from your organization. This endpoint takes no JSON arguments.","title":"list_logs_pipelines"},{"location":"v1/LogsPipelinesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all pipelines api_response = api_instance.list_logs_pipelines() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->list_logs_pipelines: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_4","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_4","text":"LogsPipelineList","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#update_logs_pipeline","text":"LogsPipeline update_logs_pipeline(pipeline_id, body) Update a pipeline Update a given pipeline configuration to change it\u2019s processors or their order. Note : Using this method updates your pipeline configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"update_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | New definition of the pipeline. # example passing only required values which don't have defaults set try: # Update a pipeline api_response = api_instance.update_logs_pipeline(pipeline_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_5","text":"Name Type Description Notes pipeline_id str ID of the pipeline to delete. body LogsPipeline New definition of the pipeline.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_5","text":"LogsPipeline","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#update_logs_pipeline_order","text":"LogsPipelinesOrder update_logs_pipeline_order(body) Update pipeline order Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors. Note : Using the PUT method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization.","title":"update_logs_pipeline_order"},{"location":"v1/LogsPipelinesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipelinesOrder( pipeline_ids=[\"tags\",\"org_ids\",\"products\"], ) # LogsPipelinesOrder | Object containing the new ordered list of pipeline IDs. # example passing only required values which don't have defaults set try: # Update pipeline order api_response = api_instance.update_logs_pipeline_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_6","text":"Name Type Description Notes body LogsPipelinesOrder Object containing the new ordered list of pipeline IDs.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_6","text":"LogsPipelinesOrder","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesOrder/","text":"LogsPipelinesOrder Object containing the ordered list of pipeline IDs. Properties Name Type Description Notes pipeline_ids [str] Ordered Array of `` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelinesOrder"},{"location":"v1/LogsPipelinesOrder/#logspipelinesorder","text":"Object containing the ordered list of pipeline IDs.","title":"LogsPipelinesOrder"},{"location":"v1/LogsPipelinesOrder/#properties","text":"Name Type Description Notes pipeline_ids [str] Ordered Array of `` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsProcessor/","text":"LogsProcessor Definition of a logs processor. Properties Name Type Description Notes is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False filter LogsFilter [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] grok LogsGrokParserRules [optional] source str Source attribute used to perform the lookup. [optional] type LogsTraceRemapperType [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. [optional] categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. [optional] expression str Arithmetic operation between one or more log attributes. [optional] template str A formula with one or more attributes and raw text. [optional] lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsProcessor"},{"location":"v1/LogsProcessor/#logsprocessor","text":"Definition of a logs processor.","title":"LogsProcessor"},{"location":"v1/LogsProcessor/#properties","text":"Name Type Description Notes is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False filter LogsFilter [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] grok LogsGrokParserRules [optional] source str Source attribute used to perform the lookup. [optional] type LogsTraceRemapperType [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. [optional] categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. [optional] expression str Arithmetic operation between one or more log attributes. [optional] template str A formula with one or more attributes and raw text. [optional] lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsQueryCompute/","text":"LogsQueryCompute Define computation for a log query. Properties Name Type Description Notes aggregation str The aggregation method. facet str Facet name. [optional] interval int Define a time interval in seconds. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsQueryCompute"},{"location":"v1/LogsQueryCompute/#logsquerycompute","text":"Define computation for a log query.","title":"LogsQueryCompute"},{"location":"v1/LogsQueryCompute/#properties","text":"Name Type Description Notes aggregation str The aggregation method. facet str Facet name. [optional] interval int Define a time interval in seconds. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsRetentionAggSumUsage/","text":"LogsRetentionAggSumUsage Object containing indexed logs usage aggregated across organizations and months for a retention period. Properties Name Type Description Notes logs_indexed_logs_usage_agg_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_agg_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_agg_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsRetentionAggSumUsage"},{"location":"v1/LogsRetentionAggSumUsage/#logsretentionaggsumusage","text":"Object containing indexed logs usage aggregated across organizations and months for a retention period.","title":"LogsRetentionAggSumUsage"},{"location":"v1/LogsRetentionAggSumUsage/#properties","text":"Name Type Description Notes logs_indexed_logs_usage_agg_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_agg_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_agg_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsRetentionSumUsage/","text":"LogsRetentionSumUsage Object containing indexed logs usage grouped by retention period and summed. Properties Name Type Description Notes logs_indexed_logs_usage_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsRetentionSumUsage"},{"location":"v1/LogsRetentionSumUsage/#logsretentionsumusage","text":"Object containing indexed logs usage grouped by retention period and summed.","title":"LogsRetentionSumUsage"},{"location":"v1/LogsRetentionSumUsage/#properties","text":"Name Type Description Notes logs_indexed_logs_usage_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsServiceRemapper/","text":"LogsServiceRemapper Use this processor if you want to assign one or more attributes as the official service. Note: If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. Properties Name Type Description Notes sources [str] Array of source attributes. type LogsServiceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsServiceRemapper"},{"location":"v1/LogsServiceRemapper/#logsserviceremapper","text":"Use this processor if you want to assign one or more attributes as the official service. Note: If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.","title":"LogsServiceRemapper"},{"location":"v1/LogsServiceRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. type LogsServiceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsServiceRemapperType/","text":"LogsServiceRemapperType Type of logs service remapper. Properties Name Type Description Notes value str Type of logs service remapper. defaults to \"service-remapper\", must be one of [\"service-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsServiceRemapperType"},{"location":"v1/LogsServiceRemapperType/#logsserviceremappertype","text":"Type of logs service remapper.","title":"LogsServiceRemapperType"},{"location":"v1/LogsServiceRemapperType/#properties","text":"Name Type Description Notes value str Type of logs service remapper. defaults to \"service-remapper\", must be one of [\"service-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsSort/","text":"LogsSort Time-ascending asc or time-descending desc results. Properties Name Type Description Notes value str Time-ascending `asc` or time-descending `desc`results. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsSort"},{"location":"v1/LogsSort/#logssort","text":"Time-ascending asc or time-descending desc results.","title":"LogsSort"},{"location":"v1/LogsSort/#properties","text":"Name Type Description Notes value str Time-ascending `asc` or time-descending `desc`results. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStatusRemapper/","text":"LogsStatusRemapper Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with emerg or f (case-insensitive) map to emerg (0) - Strings beginning with a (case-insensitive) map to alert (1) - Strings beginning with c (case-insensitive) map to critical (2) - Strings beginning with err (case-insensitive) map to error (3) - Strings beginning with w (case-insensitive) map to warning (4) - Strings beginning with n (case-insensitive) map to notice (5) - Strings beginning with i (case-insensitive) map to info (6) - Strings beginning with d , trace or verbose (case-insensitive) map to debug (7) - Strings beginning with o or matching OK or Success (case-insensitive) map to OK - All others map to info (6) Note: If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. Properties Name Type Description Notes sources [str] Array of source attributes. type LogsStatusRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStatusRemapper"},{"location":"v1/LogsStatusRemapper/#logsstatusremapper","text":"Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with emerg or f (case-insensitive) map to emerg (0) - Strings beginning with a (case-insensitive) map to alert (1) - Strings beginning with c (case-insensitive) map to critical (2) - Strings beginning with err (case-insensitive) map to error (3) - Strings beginning with w (case-insensitive) map to warning (4) - Strings beginning with n (case-insensitive) map to notice (5) - Strings beginning with i (case-insensitive) map to info (6) - Strings beginning with d , trace or verbose (case-insensitive) map to debug (7) - Strings beginning with o or matching OK or Success (case-insensitive) map to OK - All others map to info (6) Note: If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.","title":"LogsStatusRemapper"},{"location":"v1/LogsStatusRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. type LogsStatusRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStatusRemapperType/","text":"LogsStatusRemapperType Type of logs status remapper. Properties Name Type Description Notes value str Type of logs status remapper. defaults to \"status-remapper\", must be one of [\"status-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStatusRemapperType"},{"location":"v1/LogsStatusRemapperType/#logsstatusremappertype","text":"Type of logs status remapper.","title":"LogsStatusRemapperType"},{"location":"v1/LogsStatusRemapperType/#properties","text":"Name Type Description Notes value str Type of logs status remapper. defaults to \"status-remapper\", must be one of [\"status-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStringBuilderProcessor/","text":"LogsStringBuilderProcessor Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax %{attribute_path} . Notes : - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters. Properties Name Type Description Notes target str The name of the attribute that contains the result of the template. template str A formula with one or more attributes and raw text. type LogsStringBuilderProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStringBuilderProcessor"},{"location":"v1/LogsStringBuilderProcessor/#logsstringbuilderprocessor","text":"Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax %{attribute_path} . Notes : - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters.","title":"LogsStringBuilderProcessor"},{"location":"v1/LogsStringBuilderProcessor/#properties","text":"Name Type Description Notes target str The name of the attribute that contains the result of the template. template str A formula with one or more attributes and raw text. type LogsStringBuilderProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStringBuilderProcessorType/","text":"LogsStringBuilderProcessorType Type of logs string builder processor. Properties Name Type Description Notes value str Type of logs string builder processor. defaults to \"string-builder-processor\", must be one of [\"string-builder-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStringBuilderProcessorType"},{"location":"v1/LogsStringBuilderProcessorType/#logsstringbuilderprocessortype","text":"Type of logs string builder processor.","title":"LogsStringBuilderProcessorType"},{"location":"v1/LogsStringBuilderProcessorType/#properties","text":"Name Type Description Notes value str Type of logs string builder processor. defaults to \"string-builder-processor\", must be one of [\"string-builder-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsTraceRemapper/","text":"LogsTraceRemapper There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on how to inject a trace ID in the application logs and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID. Properties Name Type Description Notes type LogsTraceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] [Back to Model list] [Back to API list] [Back to README]","title":"LogsTraceRemapper"},{"location":"v1/LogsTraceRemapper/#logstraceremapper","text":"There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on how to inject a trace ID in the application logs and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID.","title":"LogsTraceRemapper"},{"location":"v1/LogsTraceRemapper/#properties","text":"Name Type Description Notes type LogsTraceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsTraceRemapperType/","text":"LogsTraceRemapperType Type of logs trace remapper. Properties Name Type Description Notes value str Type of logs trace remapper. defaults to \"trace-id-remapper\", must be one of [\"trace-id-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsTraceRemapperType"},{"location":"v1/LogsTraceRemapperType/#logstraceremappertype","text":"Type of logs trace remapper.","title":"LogsTraceRemapperType"},{"location":"v1/LogsTraceRemapperType/#properties","text":"Name Type Description Notes value str Type of logs trace remapper. defaults to \"trace-id-remapper\", must be one of [\"trace-id-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsURLParser/","text":"LogsURLParser This processor extracts query parameters and other important parameters from a URL. Properties Name Type Description Notes type LogsURLParserType sources [str] Array of source attributes. defaults to [\"http.url\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.url_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"LogsURLParser"},{"location":"v1/LogsURLParser/#logsurlparser","text":"This processor extracts query parameters and other important parameters from a URL.","title":"LogsURLParser"},{"location":"v1/LogsURLParser/#properties","text":"Name Type Description Notes type LogsURLParserType sources [str] Array of source attributes. defaults to [\"http.url\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.url_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsURLParserType/","text":"LogsURLParserType Type of logs URL parser. Properties Name Type Description Notes value str Type of logs URL parser. defaults to \"url-parser\", must be one of [\"url-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsURLParserType"},{"location":"v1/LogsURLParserType/#logsurlparsertype","text":"Type of logs URL parser.","title":"LogsURLParserType"},{"location":"v1/LogsURLParserType/#properties","text":"Name Type Description Notes value str Type of logs URL parser. defaults to \"url-parser\", must be one of [\"url-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsUserAgentParser/","text":"LogsUserAgentParser The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing. Properties Name Type Description Notes type LogsUserAgentParserType sources [str] Array of source attributes. defaults to [\"http.useragent\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.useragent_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsUserAgentParser"},{"location":"v1/LogsUserAgentParser/#logsuseragentparser","text":"The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing.","title":"LogsUserAgentParser"},{"location":"v1/LogsUserAgentParser/#properties","text":"Name Type Description Notes type LogsUserAgentParserType sources [str] Array of source attributes. defaults to [\"http.useragent\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.useragent_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsUserAgentParserType/","text":"LogsUserAgentParserType Type of logs User-Agent parser. Properties Name Type Description Notes value str Type of logs User-Agent parser. defaults to \"user-agent-parser\", must be one of [\"user-agent-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsUserAgentParserType"},{"location":"v1/LogsUserAgentParserType/#logsuseragentparsertype","text":"Type of logs User-Agent parser.","title":"LogsUserAgentParserType"},{"location":"v1/LogsUserAgentParserType/#properties","text":"Name Type Description Notes value str Type of logs User-Agent parser. defaults to \"user-agent-parser\", must be one of [\"user-agent-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricMetadata/","text":"MetricMetadata Object with all metric related metadata. Properties Name Type Description Notes description str Metric description. [optional] integration str Name of the integration that sent the metric if applicable. optional per_unit str Per unit of the metric such as `second` in `bytes per second`. [optional] short_name str A more human-readable and abbreviated version of the metric name. [optional] statsd_interval int StatsD flush interval of the metric in seconds if applicable. [optional] type str Metric type such as `gauge` or `rate`. [optional] unit str Primary unit of the metric such as `byte` or `operation`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricMetadata"},{"location":"v1/MetricMetadata/#metricmetadata","text":"Object with all metric related metadata.","title":"MetricMetadata"},{"location":"v1/MetricMetadata/#properties","text":"Name Type Description Notes description str Metric description. [optional] integration str Name of the integration that sent the metric if applicable. optional per_unit str Per unit of the metric such as `second` in `bytes per second`. [optional] short_name str A more human-readable and abbreviated version of the metric name. [optional] statsd_interval int StatsD flush interval of the metric in seconds if applicable. [optional] type str Metric type such as `gauge` or `rate`. [optional] unit str Primary unit of the metric such as `byte` or `operation`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricSearchResponse/","text":"MetricSearchResponse Object containing the list of metrics matching the search query. Properties Name Type Description Notes results MetricSearchResponseResults [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricSearchResponse"},{"location":"v1/MetricSearchResponse/#metricsearchresponse","text":"Object containing the list of metrics matching the search query.","title":"MetricSearchResponse"},{"location":"v1/MetricSearchResponse/#properties","text":"Name Type Description Notes results MetricSearchResponseResults [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricSearchResponseResults/","text":"MetricSearchResponseResults Search result. Properties Name Type Description Notes metrics [str] List of metrics that match the search query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricSearchResponseResults"},{"location":"v1/MetricSearchResponseResults/#metricsearchresponseresults","text":"Search result.","title":"MetricSearchResponseResults"},{"location":"v1/MetricSearchResponseResults/#properties","text":"Name Type Description Notes metrics [str] List of metrics that match the search query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsApi/","text":"datadog_api_client.v1.MetricsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata list_active_metrics GET /api/v1/metrics Get active metrics list list_metrics GET /api/v1/search Search metrics query_metrics GET /api/v1/query Query timeseries points submit_metrics POST /api/v1/series Submit metrics update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata get_metric_metadata MetricMetadata get_metric_metadata(metric_name) Get metric metadata Get metadata about a specific metric. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to get metadata. # example passing only required values which don't have defaults set try: # Get metric metadata api_response = api_instance.get_metric_metadata(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->get_metric_metadata: %s\\n\" % e) Parameters Name Type Description Notes metric_name str Name of the metric for which to get metadata. Return type MetricMetadata Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_active_metrics MetricsListResponse list_active_metrics(_from) Get active metrics list Get the list of actively reporting metrics from a given time until now. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Seconds since the Unix epoch. host = \"host_example\" # str | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. (optional) tag_filter = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) # example passing only required values which don't have defaults set try: # Get active metrics list api_response = api_instance.list_active_metrics(_from) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get active metrics list api_response = api_instance.list_active_metrics(_from, host=host, tag_filter=tag_filter) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e) Parameters Name Type Description Notes _from int Seconds since the Unix epoch. host str Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. [optional] tag_filter str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional] Return type MetricsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_metrics MetricSearchResponse list_metrics(q) Search metrics Search for metrics from the last 24 hours in Datadog. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) q = \"q_example\" # str | Query string to search metrics upon. Must be prefixed with `metrics:`. # example passing only required values which don't have defaults set try: # Search metrics api_response = api_instance.list_metrics(q) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_metrics: %s\\n\" % e) Parameters Name Type Description Notes q str Query string to search metrics upon. Must be prefixed with `metrics:`. Return type MetricSearchResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] query_metrics MetricsQueryResponse query_metrics(_from, to, query) Query timeseries points Query timeseries points. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Start of the queried time period, seconds since the Unix epoch. to = 1 # int | End of the queried time period, seconds since the Unix epoch. query = \"query_example\" # str | Query string. # example passing only required values which don't have defaults set try: # Query timeseries points api_response = api_instance.query_metrics(_from, to, query) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->query_metrics: %s\\n\" % e) Parameters Name Type Description Notes _from int Start of the queried time period, seconds since the Unix epoch. to int End of the queried time period, seconds since the Unix epoch. query str Query string. Return type MetricsQueryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] submit_metrics IntakePayloadAccepted submit_metrics(body) Submit metrics The metrics end-point allows you to post time-series data that can be graphed on Datadog\u2019s dashboards. The maximum payload size is 3.2 megabytes (3200000). Compressed payloads must have a decompressed size of up to 62 megabytes (62914560). If you\u2019re submitting metrics directly to the Datadog API without using DogStatsD, expect - 64 bits for the timestamp - 32 bits for the value - 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. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) body = MetricsPayload( series=[ Series( host=\"test.example.com\", interval=20, metric=\"system.load.1\", points=[ Point([[1575317847,0.5]]), ], tags=[\"environment:test\"], type=\"rate\", ), ], ) # MetricsPayload | # example passing only required values which don't have defaults set try: # Submit metrics api_response = api_instance.submit_metrics(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->submit_metrics: %s\\n\" % e) Parameters Name Type Description Notes body MetricsPayload Return type IntakePayloadAccepted Authorization apiKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_metric_metadata MetricMetadata update_metric_metadata(metric_name, body) Edit metric metadata Edit metadata of a specific metric. Find out more about supported types . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to edit metadata. body = MetricMetadata( description=\"description_example\", integration=\"integration_example\", per_unit=\"second\", short_name=\"short_name_example\", statsd_interval=1, type=\"count\", unit=\"byte\", ) # MetricMetadata | New metadata. # example passing only required values which don't have defaults set try: # Edit metric metadata api_response = api_instance.update_metric_metadata(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_metric_metadata: %s\\n\" % e) Parameters Name Type Description Notes metric_name str Name of the metric for which to edit metadata. body MetricMetadata New metadata. Return type MetricMetadata Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.MetricsApi"},{"location":"v1/MetricsApi/#datadog_api_clientv1metricsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata list_active_metrics GET /api/v1/metrics Get active metrics list list_metrics GET /api/v1/search Search metrics query_metrics GET /api/v1/query Query timeseries points submit_metrics POST /api/v1/series Submit metrics update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata","title":"datadog_api_client.v1.MetricsApi"},{"location":"v1/MetricsApi/#get_metric_metadata","text":"MetricMetadata get_metric_metadata(metric_name) Get metric metadata Get metadata about a specific metric.","title":"get_metric_metadata"},{"location":"v1/MetricsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to get metadata. # example passing only required values which don't have defaults set try: # Get metric metadata api_response = api_instance.get_metric_metadata(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->get_metric_metadata: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters","text":"Name Type Description Notes metric_name str Name of the metric for which to get metadata.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type","text":"MetricMetadata","title":"Return type"},{"location":"v1/MetricsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#list_active_metrics","text":"MetricsListResponse list_active_metrics(_from) Get active metrics list Get the list of actively reporting metrics from a given time until now.","title":"list_active_metrics"},{"location":"v1/MetricsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Seconds since the Unix epoch. host = \"host_example\" # str | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. (optional) tag_filter = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) # example passing only required values which don't have defaults set try: # Get active metrics list api_response = api_instance.list_active_metrics(_from) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get active metrics list api_response = api_instance.list_active_metrics(_from, host=host, tag_filter=tag_filter) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_1","text":"Name Type Description Notes _from int Seconds since the Unix epoch. host str Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. [optional] tag_filter str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional]","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_1","text":"MetricsListResponse","title":"Return type"},{"location":"v1/MetricsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#list_metrics","text":"MetricSearchResponse list_metrics(q) Search metrics Search for metrics from the last 24 hours in Datadog.","title":"list_metrics"},{"location":"v1/MetricsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) q = \"q_example\" # str | Query string to search metrics upon. Must be prefixed with `metrics:`. # example passing only required values which don't have defaults set try: # Search metrics api_response = api_instance.list_metrics(q) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_2","text":"Name Type Description Notes q str Query string to search metrics upon. Must be prefixed with `metrics:`.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_2","text":"MetricSearchResponse","title":"Return type"},{"location":"v1/MetricsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#query_metrics","text":"MetricsQueryResponse query_metrics(_from, to, query) Query timeseries points Query timeseries points.","title":"query_metrics"},{"location":"v1/MetricsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Start of the queried time period, seconds since the Unix epoch. to = 1 # int | End of the queried time period, seconds since the Unix epoch. query = \"query_example\" # str | Query string. # example passing only required values which don't have defaults set try: # Query timeseries points api_response = api_instance.query_metrics(_from, to, query) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->query_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_3","text":"Name Type Description Notes _from int Start of the queried time period, seconds since the Unix epoch. to int End of the queried time period, seconds since the Unix epoch. query str Query string.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_3","text":"MetricsQueryResponse","title":"Return type"},{"location":"v1/MetricsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#submit_metrics","text":"IntakePayloadAccepted submit_metrics(body) Submit metrics The metrics end-point allows you to post time-series data that can be graphed on Datadog\u2019s dashboards. The maximum payload size is 3.2 megabytes (3200000). Compressed payloads must have a decompressed size of up to 62 megabytes (62914560). If you\u2019re submitting metrics directly to the Datadog API without using DogStatsD, expect - 64 bits for the timestamp - 32 bits for the value - 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.","title":"submit_metrics"},{"location":"v1/MetricsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) body = MetricsPayload( series=[ Series( host=\"test.example.com\", interval=20, metric=\"system.load.1\", points=[ Point([[1575317847,0.5]]), ], tags=[\"environment:test\"], type=\"rate\", ), ], ) # MetricsPayload | # example passing only required values which don't have defaults set try: # Submit metrics api_response = api_instance.submit_metrics(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->submit_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_4","text":"Name Type Description Notes body MetricsPayload","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_4","text":"IntakePayloadAccepted","title":"Return type"},{"location":"v1/MetricsApi/#authorization_4","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_4","text":"Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#update_metric_metadata","text":"MetricMetadata update_metric_metadata(metric_name, body) Edit metric metadata Edit metadata of a specific metric. Find out more about supported types .","title":"update_metric_metadata"},{"location":"v1/MetricsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to edit metadata. body = MetricMetadata( description=\"description_example\", integration=\"integration_example\", per_unit=\"second\", short_name=\"short_name_example\", statsd_interval=1, type=\"count\", unit=\"byte\", ) # MetricMetadata | New metadata. # example passing only required values which don't have defaults set try: # Edit metric metadata api_response = api_instance.update_metric_metadata(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_metric_metadata: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_5","text":"Name Type Description Notes metric_name str Name of the metric for which to edit metadata. body MetricMetadata New metadata.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_5","text":"MetricMetadata","title":"Return type"},{"location":"v1/MetricsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsListResponse/","text":"MetricsListResponse Object listing all metric names stored by Datadog since a given time. Properties Name Type Description Notes _from str Time when the metrics were active, seconds since the Unix epoch. [optional] metrics [str] List of metric names. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricsListResponse"},{"location":"v1/MetricsListResponse/#metricslistresponse","text":"Object listing all metric names stored by Datadog since a given time.","title":"MetricsListResponse"},{"location":"v1/MetricsListResponse/#properties","text":"Name Type Description Notes _from str Time when the metrics were active, seconds since the Unix epoch. [optional] metrics [str] List of metric names. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsPayload/","text":"MetricsPayload The metrics' payload. Properties Name Type Description Notes series [Series] A list of time series to submit to Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"MetricsPayload"},{"location":"v1/MetricsPayload/#metricspayload","text":"The metrics' payload.","title":"MetricsPayload"},{"location":"v1/MetricsPayload/#properties","text":"Name Type Description Notes series [Series] A list of time series to submit to Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsQueryMetadata/","text":"MetricsQueryMetadata Object containing all metric names returned and their associated metadata. Properties Name Type Description Notes aggr str Aggregation type. optional display_name str Display name of the metric. optional end int End of the time window, milliseconds since Unix epoch. optional expression str Metric expression. optional interval int Number of seconds between data samples. optional length int Number of data samples. optional metric str Metric name. optional pointlist [Point] List of points of the time series. optional scope str Metric scope, comma separated list of tags. optional start int Start of the time window, milliseconds since Unix epoch. optional unit [MetricsQueryUnit] 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 [Back to Model list] [Back to API list] [Back to README]","title":"MetricsQueryMetadata"},{"location":"v1/MetricsQueryMetadata/#metricsquerymetadata","text":"Object containing all metric names returned and their associated metadata.","title":"MetricsQueryMetadata"},{"location":"v1/MetricsQueryMetadata/#properties","text":"Name Type Description Notes aggr str Aggregation type. optional display_name str Display name of the metric. optional end int End of the time window, milliseconds since Unix epoch. optional expression str Metric expression. optional interval int Number of seconds between data samples. optional length int Number of data samples. optional metric str Metric name. optional pointlist [Point] List of points of the time series. optional scope str Metric scope, comma separated list of tags. optional start int Start of the time window, milliseconds since Unix epoch. optional unit [MetricsQueryUnit] 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 [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsQueryResponse/","text":"MetricsQueryResponse Response Object that includes your query and the list of metrics retrieved. Properties Name Type Description Notes error str Message indicating the errors if status is not `ok`. optional from_date int Start of requested time window, milliseconds since Unix epoch. optional group_by [str] List of tag keys on which to group. optional message str Message indicating `success` if status is `ok`. optional query str Query string optional res_type str Type of response. optional series [MetricsQueryMetadata] List of timeseries queried. optional status str Status of the query. optional to_date int End of requested time window, milliseconds since Unix epoch. optional [Back to Model list] [Back to API list] [Back to README]","title":"MetricsQueryResponse"},{"location":"v1/MetricsQueryResponse/#metricsqueryresponse","text":"Response Object that includes your query and the list of metrics retrieved.","title":"MetricsQueryResponse"},{"location":"v1/MetricsQueryResponse/#properties","text":"Name Type Description Notes error str Message indicating the errors if status is not `ok`. optional from_date int Start of requested time window, milliseconds since Unix epoch. optional group_by [str] List of tag keys on which to group. optional message str Message indicating `success` if status is `ok`. optional query str Query string optional res_type str Type of response. optional series [MetricsQueryMetadata] List of timeseries queried. optional status str Status of the query. optional to_date int End of requested time window, milliseconds since Unix epoch. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsQueryUnit/","text":"MetricsQueryUnit Object containing the metric unit family, scale factor, name, and short name. Properties Name Type Description Notes family str Unit family, allows for conversion between units of the same family, for scaling. optional name str Unit name optional plural str Plural form of the unit name. optional scale_factor float Factor for scaling between units of the same family. optional short_name str Abbreviation of the unit. optional [Back to Model list] [Back to API list] [Back to README]","title":"MetricsQueryUnit"},{"location":"v1/MetricsQueryUnit/#metricsqueryunit","text":"Object containing the metric unit family, scale factor, name, and short name.","title":"MetricsQueryUnit"},{"location":"v1/MetricsQueryUnit/#properties","text":"Name Type Description Notes family str Unit family, allows for conversion between units of the same family, for scaling. optional name str Unit name optional plural str Plural form of the unit name. optional scale_factor float Factor for scaling between units of the same family. optional short_name str Abbreviation of the unit. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Monitor/","text":"Monitor Object describing a monitor. Properties Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Monitor"},{"location":"v1/Monitor/#monitor","text":"Object describing a monitor.","title":"Monitor"},{"location":"v1/Monitor/#properties","text":"Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorDeviceID/","text":"MonitorDeviceID ID of the device the Synthetics monitor is running on. Same as SyntheticsDeviceID . Properties Name Type Description Notes value str ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorDeviceID"},{"location":"v1/MonitorDeviceID/#monitordeviceid","text":"ID of the device the Synthetics monitor is running on. Same as SyntheticsDeviceID .","title":"MonitorDeviceID"},{"location":"v1/MonitorDeviceID/#properties","text":"Name Type Description Notes value str ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorOptions/","text":"MonitorOptions List of options associated with your monitor. Properties Name Type Description Notes aggregation MonitorOptionsAggregation [optional] device_ids [MonitorDeviceID] IDs of the device the Synthetics monitor is running on. optional enable_logs_sample bool Whether or not to send a log sample when the log monitor triggers. [optional] escalation_message str A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. [optional] if omitted the server will use the default value of \"none\" evaluation_delay int, none_type 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 bool Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. [optional] include_tags bool 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] if omitted the server will use the default value of True locked bool Whether or not the monitor is locked (only editable by creator and admins). [optional] min_failure_duration int, none_type How long the test should be in failure before alerting (integer, number of seconds, max 7200). [optional] if omitted the server will use the default value of 0 min_location_failed int, none_type 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] if omitted the server will use the default value of 1 new_host_delay int, none_type 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. [optional] if omitted the server will use the default value of 300 no_data_timeframe int, none_type 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 bool A Boolean indicating whether tagged users is notified on changes to this monitor. [optional] if omitted the server will use the default value of False notify_no_data bool A Boolean indicating whether this monitor notifies when data stops reporting. [optional] if omitted the server will use the default value of False renotify_interval int, none_type The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it\u2019s not resolved. [optional] require_full_window bool A Boolean indicating whether this monitor needs a full window of data before it\u2019s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. [optional] silenced {str: (int, none_type)} Information about the downtime applied to the monitor. [optional] synthetics_check_id str, none_type ID of the corresponding Synthetic check. [optional] threshold_windows MonitorThresholdWindowOptions [optional] thresholds MonitorThresholds [optional] timeout_h int, none_type The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorOptions"},{"location":"v1/MonitorOptions/#monitoroptions","text":"List of options associated with your monitor.","title":"MonitorOptions"},{"location":"v1/MonitorOptions/#properties","text":"Name Type Description Notes aggregation MonitorOptionsAggregation [optional] device_ids [MonitorDeviceID] IDs of the device the Synthetics monitor is running on. optional enable_logs_sample bool Whether or not to send a log sample when the log monitor triggers. [optional] escalation_message str A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. [optional] if omitted the server will use the default value of \"none\" evaluation_delay int, none_type 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 bool Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. [optional] include_tags bool 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] if omitted the server will use the default value of True locked bool Whether or not the monitor is locked (only editable by creator and admins). [optional] min_failure_duration int, none_type How long the test should be in failure before alerting (integer, number of seconds, max 7200). [optional] if omitted the server will use the default value of 0 min_location_failed int, none_type 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] if omitted the server will use the default value of 1 new_host_delay int, none_type 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. [optional] if omitted the server will use the default value of 300 no_data_timeframe int, none_type 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 bool A Boolean indicating whether tagged users is notified on changes to this monitor. [optional] if omitted the server will use the default value of False notify_no_data bool A Boolean indicating whether this monitor notifies when data stops reporting. [optional] if omitted the server will use the default value of False renotify_interval int, none_type The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it\u2019s not resolved. [optional] require_full_window bool A Boolean indicating whether this monitor needs a full window of data before it\u2019s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. [optional] silenced {str: (int, none_type)} Information about the downtime applied to the monitor. [optional] synthetics_check_id str, none_type ID of the corresponding Synthetic check. [optional] threshold_windows MonitorThresholdWindowOptions [optional] thresholds MonitorThresholds [optional] timeout_h int, none_type The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorOptionsAggregation/","text":"MonitorOptionsAggregation Type of aggregation performed in the monitor query. Properties Name Type Description Notes group_by str Group to break down the monitor on. [optional] metric str Metric name used in the monitor. [optional] type str Metric type used in the monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorOptionsAggregation"},{"location":"v1/MonitorOptionsAggregation/#monitoroptionsaggregation","text":"Type of aggregation performed in the monitor query.","title":"MonitorOptionsAggregation"},{"location":"v1/MonitorOptionsAggregation/#properties","text":"Name Type Description Notes group_by str Group to break down the monitor on. [optional] metric str Metric name used in the monitor. [optional] type str Metric type used in the monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorOverallStates/","text":"MonitorOverallStates The different states your monitor can be in. Properties Name Type Description Notes value str The different states your monitor can be in. must be one of [\"Alert\", \"Ignored\", \"No Data\", \"OK\", \"Skipped\", \"Unknown\", \"Warn\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorOverallStates"},{"location":"v1/MonitorOverallStates/#monitoroverallstates","text":"The different states your monitor can be in.","title":"MonitorOverallStates"},{"location":"v1/MonitorOverallStates/#properties","text":"Name Type Description Notes value str The different states your monitor can be in. must be one of [\"Alert\", \"Ignored\", \"No Data\", \"OK\", \"Skipped\", \"Unknown\", \"Warn\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorState/","text":"MonitorState Wrapper object with the different monitor states. Properties Name Type Description Notes groups {str: (MonitorStateGroup,)} 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] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorState"},{"location":"v1/MonitorState/#monitorstate","text":"Wrapper object with the different monitor states.","title":"MonitorState"},{"location":"v1/MonitorState/#properties","text":"Name Type Description Notes groups {str: (MonitorStateGroup,)} 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorStateGroup/","text":"MonitorStateGroup Monitor state for a single group. Properties Name Type Description Notes last_nodata_ts int Latest timestamp the monitor was in NO_DATA state. [optional] last_notified_ts int Latest timestamp of the notification sent for this monitor group. [optional] last_resolved_ts int Latest timestamp the monitor group was resolved. [optional] last_triggered_ts int Latest timestamp the monitor group triggered. [optional] name str The name of the monitor. [optional] status MonitorOverallStates [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorStateGroup"},{"location":"v1/MonitorStateGroup/#monitorstategroup","text":"Monitor state for a single group.","title":"MonitorStateGroup"},{"location":"v1/MonitorStateGroup/#properties","text":"Name Type Description Notes last_nodata_ts int Latest timestamp the monitor was in NO_DATA state. [optional] last_notified_ts int Latest timestamp of the notification sent for this monitor group. [optional] last_resolved_ts int Latest timestamp the monitor group was resolved. [optional] last_triggered_ts int Latest timestamp the monitor group triggered. [optional] name str The name of the monitor. [optional] status MonitorOverallStates [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorSummaryWidgetDefinition/","text":"MonitorSummaryWidgetDefinition The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards. Properties Name Type Description Notes query str Query to filter the monitors with. type MonitorSummaryWidgetDefinitionType color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetMonitorSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] sort WidgetMonitorSummarySort [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorSummaryWidgetDefinition"},{"location":"v1/MonitorSummaryWidgetDefinition/#monitorsummarywidgetdefinition","text":"The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.","title":"MonitorSummaryWidgetDefinition"},{"location":"v1/MonitorSummaryWidgetDefinition/#properties","text":"Name Type Description Notes query str Query to filter the monitors with. type MonitorSummaryWidgetDefinitionType color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetMonitorSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] sort WidgetMonitorSummarySort [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorSummaryWidgetDefinitionType/","text":"MonitorSummaryWidgetDefinitionType Type of the monitor summary widget. Properties Name Type Description Notes value str Type of the monitor summary widget. defaults to \"manage_status\", must be one of [\"manage_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorSummaryWidgetDefinitionType"},{"location":"v1/MonitorSummaryWidgetDefinitionType/#monitorsummarywidgetdefinitiontype","text":"Type of the monitor summary widget.","title":"MonitorSummaryWidgetDefinitionType"},{"location":"v1/MonitorSummaryWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the monitor summary widget. defaults to \"manage_status\", must be one of [\"manage_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorThresholdWindowOptions/","text":"MonitorThresholdWindowOptions Alerting time window options. Properties Name Type Description Notes recovery_window str, none_type Describes how long an anomalous metric must be normal before the alert recovers. [optional] trigger_window str, none_type Describes how long a metric must be anomalous before an alert triggers. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorThresholdWindowOptions"},{"location":"v1/MonitorThresholdWindowOptions/#monitorthresholdwindowoptions","text":"Alerting time window options.","title":"MonitorThresholdWindowOptions"},{"location":"v1/MonitorThresholdWindowOptions/#properties","text":"Name Type Description Notes recovery_window str, none_type Describes how long an anomalous metric must be normal before the alert recovers. [optional] trigger_window str, none_type Describes how long a metric must be anomalous before an alert triggers. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorThresholds/","text":"MonitorThresholds List of the different monitor threshold available. Properties Name Type Description Notes critical float The monitor `CRITICAL` threshold. [optional] critical_recovery float, none_type The monitor `CRITICAL` recovery threshold. [optional] ok float, none_type The monitor `OK` threshold. [optional] unknown float, none_type The monitor UNKNOWN threshold. [optional] warning float, none_type The monitor `WARNING` threshold. [optional] warning_recovery float, none_type The monitor `WARNING` recovery threshold. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorThresholds"},{"location":"v1/MonitorThresholds/#monitorthresholds","text":"List of the different monitor threshold available.","title":"MonitorThresholds"},{"location":"v1/MonitorThresholds/#properties","text":"Name Type Description Notes critical float The monitor `CRITICAL` threshold. [optional] critical_recovery float, none_type The monitor `CRITICAL` recovery threshold. [optional] ok float, none_type The monitor `OK` threshold. [optional] unknown float, none_type The monitor UNKNOWN threshold. [optional] warning float, none_type The monitor `WARNING` threshold. [optional] warning_recovery float, none_type The monitor `WARNING` recovery threshold. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorType/","text":"MonitorType The type of the monitor. For more information about type , see the monitor options docs. Properties Name Type Description Notes value str The type of the monitor. For more information about `type`, see the monitor options docs. must be one of [\"composite\", \"event alert\", \"log alert\", \"metric alert\", \"process alert\", \"query alert\", \"rum alert\", \"service check\", \"synthetics alert\", \"trace-analytics alert\", \"slo alert\", \"event-v2 alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorType"},{"location":"v1/MonitorType/#monitortype","text":"The type of the monitor. For more information about type , see the monitor options docs.","title":"MonitorType"},{"location":"v1/MonitorType/#properties","text":"Name Type Description Notes value str The type of the monitor. For more information about `type`, see the monitor options docs. must be one of [\"composite\", \"event alert\", \"log alert\", \"metric alert\", \"process alert\", \"query alert\", \"rum alert\", \"service check\", \"synthetics alert\", \"trace-analytics alert\", \"slo alert\", \"event-v2 alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorUpdateRequest/","text":"MonitorUpdateRequest Object describing a monitor update request. Properties Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorUpdateRequest"},{"location":"v1/MonitorUpdateRequest/#monitorupdaterequest","text":"Object describing a monitor update request.","title":"MonitorUpdateRequest"},{"location":"v1/MonitorUpdateRequest/#properties","text":"Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorsApi/","text":"datadog_api_client.v1.MonitorsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted create_monitor POST /api/v1/monitor Create a monitor delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details list_monitors GET /api/v1/monitor Get all monitor details update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor validate_monitor POST /api/v1/monitor/validate Validate a monitor check_can_delete_monitor CheckCanDeleteMonitorResponse check_can_delete_monitor(monitor_ids) Check if a monitor can be deleted Check if the given monitors can be deleted. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_ids = [ 1, ] # [int] | The IDs of the monitor to check. # example passing only required values which don't have defaults set try: # Check if a monitor can be deleted api_response = api_instance.check_can_delete_monitor(monitor_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->check_can_delete_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_ids [int] The IDs of the monitor to check. Return type CheckCanDeleteMonitorResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Deletion conflict error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_monitor Monitor create_monitor(body) Create a monitor Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: query alert - APM: query alert or trace-analytics alert - composite: composite - custom: service check - event: event alert - forecast: query alert - host: service check - integration: query alert or service check - live process: process alert - logs: log alert - metric: metric alert - network: service check - outlier: query alert - process: service check - rum: rum alert - SLO: slo alert - watchdog: event alert - event-v2: event-v2 alert #### Query Types Metric Alert Query 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 2880 depending on the monitor type) or last_#h (with # between 1 and 48 depending on the monitor type), or last_1d - space_aggr : avg, sum, min, or max - 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: - change_aggr change, pct_change - time_aggr avg, sum, max, min Learn more - 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: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0 Service Check Query Example: \\\"check\\\".over(tags).last(count).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\\\") - 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 3. Event Alert Query Example: events('sources:nagios status:error,warning priority:normal tags: \\\"string query\\\"').rollup(\\\"count\\\").last(\\\"1h\\\")\\\" - event , the event query string: - string_query free text query to match against event title and text. - sources event sources (comma-separated). - status event statuses (comma-separated). Valid options: error, warn, and info. - priority event priorities (comma-separated). Valid options: low, normal, all. - host event reporting host (comma-separated). - tags event tags (comma-separated). - excluded_tags excluded event tags (comma-separated). - rollup the stats roll-up method. count is the only supported method now. - last the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. NOTE Only available on US1 and EU. Event V2 Alert Query Example: events(query).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. NOTE Only available on US1-FED, US3, and in closed beta on EU and US1. Process Alert Query 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 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 != - # an integer or decimal number used to set the threshold Logs Alert Query Example: logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - index_name For multi-index organizations, the log index in which the request is performed. - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48) - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. Composite Query 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. SLO Alert Query Example: error_budget(\\\"slo_id\\\").over(\\\"time_window\\\") operator # - slo_id : The alphanumeric SLO ID of the SLO you are configuring the alert for. - time_window : The time window of the SLO target you wish to alert on. Valid options: 7d , 30d , 90d . - operator *: >= or > Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Create a monitor request body. # example passing only required values which don't have defaults set try: # Create a monitor api_response = api_instance.create_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->create_monitor: %s\\n\" % e) Parameters Name Type Description Notes body Monitor Create a monitor request body. Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_monitor DeletedMonitor delete_monitor(monitor_id) Delete a monitor Delete the specified monitor Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The ID of the monitor. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional] Return type DeletedMonitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Item not found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_monitor Monitor get_monitor(monitor_id) Get a monitor's details Get details about the specified monitor from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) # example passing only required values which don't have defaults set try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id, group_states=group_states) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The ID of the monitor group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional] Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_monitors [Monitor] list_monitors() Get all monitor details Get details about the specified monitor from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) name = \"name_example\" # str | A string to filter monitors by name. (optional) tags = \"tags_example\" # str | 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 = \"monitor_tags_example\" # str | 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 = True # bool | If this argument is set to true, then the returned data includes all current downtimes for each monitor. (optional) id_offset = 1 # int | Monitor ID offset. (optional) page = 1 # int | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. (optional) page_size = 1 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # Get all monitor details api_response = api_instance.list_monitors(group_states=group_states, name=name, tags=tags, monitor_tags=monitor_tags, with_downtimes=with_downtimes, id_offset=id_offset, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->list_monitors: %s\\n\" % e) Parameters Name Type Description Notes group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional] name str A string to filter monitors by name. [optional] tags str 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 str 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 bool If this argument is set to true, then the returned data includes all current downtimes for each monitor. [optional] id_offset int Monitor ID offset. [optional] page int The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. [optional] page_size int 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 [Monitor] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_monitor Monitor update_monitor(monitor_id, body) Edit a monitor Edit the specified monitor. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. body = MonitorUpdateRequest( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # MonitorUpdateRequest | Edit a monitor request body. # example passing only required values which don't have defaults set try: # Edit a monitor api_response = api_instance.update_monitor(monitor_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->update_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The ID of the monitor. body MonitorUpdateRequest Edit a monitor request body. Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] validate_monitor Monitor validate_monitor(body) Validate a monitor Validate the monitor provided in the request. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Monitor request object # example passing only required values which don't have defaults set try: # Validate a monitor api_response = api_instance.validate_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->validate_monitor: %s\\n\" % e) Parameters Name Type Description Notes body Monitor Monitor request object Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid JSON - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.MonitorsApi"},{"location":"v1/MonitorsApi/#datadog_api_clientv1monitorsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted create_monitor POST /api/v1/monitor Create a monitor delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details list_monitors GET /api/v1/monitor Get all monitor details update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor validate_monitor POST /api/v1/monitor/validate Validate a monitor","title":"datadog_api_client.v1.MonitorsApi"},{"location":"v1/MonitorsApi/#check_can_delete_monitor","text":"CheckCanDeleteMonitorResponse check_can_delete_monitor(monitor_ids) Check if a monitor can be deleted Check if the given monitors can be deleted.","title":"check_can_delete_monitor"},{"location":"v1/MonitorsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_ids = [ 1, ] # [int] | The IDs of the monitor to check. # example passing only required values which don't have defaults set try: # Check if a monitor can be deleted api_response = api_instance.check_can_delete_monitor(monitor_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->check_can_delete_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters","text":"Name Type Description Notes monitor_ids [int] The IDs of the monitor to check.","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type","text":"CheckCanDeleteMonitorResponse","title":"Return type"},{"location":"v1/MonitorsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Deletion conflict error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#create_monitor","text":"Monitor create_monitor(body) Create a monitor Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: query alert - APM: query alert or trace-analytics alert - composite: composite - custom: service check - event: event alert - forecast: query alert - host: service check - integration: query alert or service check - live process: process alert - logs: log alert - metric: metric alert - network: service check - outlier: query alert - process: service check - rum: rum alert - SLO: slo alert - watchdog: event alert - event-v2: event-v2 alert #### Query Types Metric Alert Query 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 2880 depending on the monitor type) or last_#h (with # between 1 and 48 depending on the monitor type), or last_1d - space_aggr : avg, sum, min, or max - 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: - change_aggr change, pct_change - time_aggr avg, sum, max, min Learn more - 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: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0 Service Check Query Example: \\\"check\\\".over(tags).last(count).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\\\") - 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 3. Event Alert Query Example: events('sources:nagios status:error,warning priority:normal tags: \\\"string query\\\"').rollup(\\\"count\\\").last(\\\"1h\\\")\\\" - event , the event query string: - string_query free text query to match against event title and text. - sources event sources (comma-separated). - status event statuses (comma-separated). Valid options: error, warn, and info. - priority event priorities (comma-separated). Valid options: low, normal, all. - host event reporting host (comma-separated). - tags event tags (comma-separated). - excluded_tags excluded event tags (comma-separated). - rollup the stats roll-up method. count is the only supported method now. - last the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. NOTE Only available on US1 and EU. Event V2 Alert Query Example: events(query).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. NOTE Only available on US1-FED, US3, and in closed beta on EU and US1. Process Alert Query 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 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 != - # an integer or decimal number used to set the threshold Logs Alert Query Example: logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - index_name For multi-index organizations, the log index in which the request is performed. - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48) - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. Composite Query 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. SLO Alert Query Example: error_budget(\\\"slo_id\\\").over(\\\"time_window\\\") operator # - slo_id : The alphanumeric SLO ID of the SLO you are configuring the alert for. - time_window : The time window of the SLO target you wish to alert on. Valid options: 7d , 30d , 90d . - operator *: >= or >","title":"create_monitor"},{"location":"v1/MonitorsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Create a monitor request body. # example passing only required values which don't have defaults set try: # Create a monitor api_response = api_instance.create_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->create_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_1","text":"Name Type Description Notes body Monitor Create a monitor request body.","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_1","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#delete_monitor","text":"DeletedMonitor delete_monitor(monitor_id) Delete a monitor Delete the specified monitor","title":"delete_monitor"},{"location":"v1/MonitorsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_2","text":"Name Type Description Notes monitor_id int The ID of the monitor. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional]","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_2","text":"DeletedMonitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Item not found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#get_monitor","text":"Monitor get_monitor(monitor_id) Get a monitor's details Get details about the specified monitor from your organization.","title":"get_monitor"},{"location":"v1/MonitorsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) # example passing only required values which don't have defaults set try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id, group_states=group_states) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_3","text":"Name Type Description Notes monitor_id int The ID of the monitor group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional]","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_3","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#list_monitors","text":"[Monitor] list_monitors() Get all monitor details Get details about the specified monitor from your organization.","title":"list_monitors"},{"location":"v1/MonitorsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) name = \"name_example\" # str | A string to filter monitors by name. (optional) tags = \"tags_example\" # str | 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 = \"monitor_tags_example\" # str | 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 = True # bool | If this argument is set to true, then the returned data includes all current downtimes for each monitor. (optional) id_offset = 1 # int | Monitor ID offset. (optional) page = 1 # int | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. (optional) page_size = 1 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # Get all monitor details api_response = api_instance.list_monitors(group_states=group_states, name=name, tags=tags, monitor_tags=monitor_tags, with_downtimes=with_downtimes, id_offset=id_offset, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->list_monitors: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_4","text":"Name Type Description Notes group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional] name str A string to filter monitors by name. [optional] tags str 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 str 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 bool If this argument is set to true, then the returned data includes all current downtimes for each monitor. [optional] id_offset int Monitor ID offset. [optional] page int The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. [optional] page_size int 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]","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_4","text":"[Monitor]","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#update_monitor","text":"Monitor update_monitor(monitor_id, body) Edit a monitor Edit the specified monitor.","title":"update_monitor"},{"location":"v1/MonitorsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. body = MonitorUpdateRequest( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # MonitorUpdateRequest | Edit a monitor request body. # example passing only required values which don't have defaults set try: # Edit a monitor api_response = api_instance.update_monitor(monitor_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->update_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_5","text":"Name Type Description Notes monitor_id int The ID of the monitor. body MonitorUpdateRequest Edit a monitor request body.","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_5","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#validate_monitor","text":"Monitor validate_monitor(body) Validate a monitor Validate the monitor provided in the request.","title":"validate_monitor"},{"location":"v1/MonitorsApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Monitor request object # example passing only required values which don't have defaults set try: # Validate a monitor api_response = api_instance.validate_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->validate_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_6","text":"Name Type Description Notes body Monitor Monitor request object","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_6","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Invalid JSON - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/NoteWidgetDefinition/","text":"NoteWidgetDefinition The notes and links widget is similar to free text widget, but allows for more formatting options. Properties Name Type Description Notes content str Content of the note. type NoteWidgetDefinitionType background_color str Background color of the note. [optional] font_size str Size of the text. [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] text_align WidgetTextAlign [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"NoteWidgetDefinition"},{"location":"v1/NoteWidgetDefinition/#notewidgetdefinition","text":"The notes and links widget is similar to free text widget, but allows for more formatting options.","title":"NoteWidgetDefinition"},{"location":"v1/NoteWidgetDefinition/#properties","text":"Name Type Description Notes content str Content of the note. type NoteWidgetDefinitionType background_color str Background color of the note. [optional] font_size str Size of the text. [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] text_align WidgetTextAlign [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/NoteWidgetDefinitionType/","text":"NoteWidgetDefinitionType Type of the note widget. Properties Name Type Description Notes value str Type of the note widget. defaults to \"note\", must be one of [\"note\", ] [Back to Model list] [Back to API list] [Back to README]","title":"NoteWidgetDefinitionType"},{"location":"v1/NoteWidgetDefinitionType/#notewidgetdefinitiontype","text":"Type of the note widget.","title":"NoteWidgetDefinitionType"},{"location":"v1/NoteWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the note widget. defaults to \"note\", must be one of [\"note\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Organization/","text":"Organization Create, edit, and manage organizations. Properties Name Type Description Notes billing OrganizationBilling [optional] created str Date of the organization creation. optional description str Description of the organization. [optional] name str The name of the new child-organization, limited to 32 characters. [optional] public_id str The `public_id` of the organization you are operating within. [optional] settings OrganizationSettings [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Organization"},{"location":"v1/Organization/#organization","text":"Create, edit, and manage organizations.","title":"Organization"},{"location":"v1/Organization/#properties","text":"Name Type Description Notes billing OrganizationBilling [optional] created str Date of the organization creation. optional description str Description of the organization. [optional] name str The name of the new child-organization, limited to 32 characters. [optional] public_id str The `public_id` of the organization you are operating within. [optional] settings OrganizationSettings [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationBilling/","text":"OrganizationBilling A JSON array of billing type. Properties Name Type Description Notes type str The type of billing. Only `parent_billing` is supported. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationBilling"},{"location":"v1/OrganizationBilling/#organizationbilling","text":"A JSON array of billing type.","title":"OrganizationBilling"},{"location":"v1/OrganizationBilling/#properties","text":"Name Type Description Notes type str The type of billing. Only `parent_billing` is supported. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationCreateBody/","text":"OrganizationCreateBody Object describing an organization to create. Properties Name Type Description Notes name str The name of the new child-organization, limited to 32 characters. billing OrganizationBilling [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationCreateBody"},{"location":"v1/OrganizationCreateBody/#organizationcreatebody","text":"Object describing an organization to create.","title":"OrganizationCreateBody"},{"location":"v1/OrganizationCreateBody/#properties","text":"Name Type Description Notes name str The name of the new child-organization, limited to 32 characters. billing OrganizationBilling [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationCreateResponse/","text":"OrganizationCreateResponse Response object for an organization creation. Properties Name Type Description Notes api_key ApiKey [optional] application_key ApplicationKey [optional] org Organization [optional] user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationCreateResponse"},{"location":"v1/OrganizationCreateResponse/#organizationcreateresponse","text":"Response object for an organization creation.","title":"OrganizationCreateResponse"},{"location":"v1/OrganizationCreateResponse/#properties","text":"Name Type Description Notes api_key ApiKey [optional] application_key ApplicationKey [optional] org Organization [optional] user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationListResponse/","text":"OrganizationListResponse Response with the list of organizations. Properties Name Type Description Notes orgs [Organization] Array of organization objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationListResponse"},{"location":"v1/OrganizationListResponse/#organizationlistresponse","text":"Response with the list of organizations.","title":"OrganizationListResponse"},{"location":"v1/OrganizationListResponse/#properties","text":"Name Type Description Notes orgs [Organization] Array of organization objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationResponse/","text":"OrganizationResponse Response with an organization. Properties Name Type Description Notes org Organization [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationResponse"},{"location":"v1/OrganizationResponse/#organizationresponse","text":"Response with an organization.","title":"OrganizationResponse"},{"location":"v1/OrganizationResponse/#properties","text":"Name Type Description Notes org Organization [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettings/","text":"OrganizationSettings A JSON array of settings. Properties Name Type Description Notes private_widget_share bool Whether or not the organization users can share widgets outside of Datadog. [optional] saml OrganizationSettingsSaml [optional] saml_autocreate_access_role AccessRole [optional] saml_autocreate_users_domains OrganizationSettingsSamlAutocreateUsersDomains [optional] saml_can_be_enabled bool Whether or not SAML can be enabled for this organization. [optional] saml_idp_endpoint str Identity provider endpoint for SAML authentication. [optional] saml_idp_initiated_login OrganizationSettingsSamlIdpInitiatedLogin [optional] saml_idp_metadata_uploaded bool Whether or not a SAML identity provider metadata file was provided to the Datadog organization. [optional] saml_login_url str URL for SAML logging. [optional] saml_strict_mode OrganizationSettingsSamlStrictMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettings"},{"location":"v1/OrganizationSettings/#organizationsettings","text":"A JSON array of settings.","title":"OrganizationSettings"},{"location":"v1/OrganizationSettings/#properties","text":"Name Type Description Notes private_widget_share bool Whether or not the organization users can share widgets outside of Datadog. [optional] saml OrganizationSettingsSaml [optional] saml_autocreate_access_role AccessRole [optional] saml_autocreate_users_domains OrganizationSettingsSamlAutocreateUsersDomains [optional] saml_can_be_enabled bool Whether or not SAML can be enabled for this organization. [optional] saml_idp_endpoint str Identity provider endpoint for SAML authentication. [optional] saml_idp_initiated_login OrganizationSettingsSamlIdpInitiatedLogin [optional] saml_idp_metadata_uploaded bool Whether or not a SAML identity provider metadata file was provided to the Datadog organization. [optional] saml_login_url str URL for SAML logging. [optional] saml_strict_mode OrganizationSettingsSamlStrictMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSaml/","text":"OrganizationSettingsSaml Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings. Properties Name Type Description Notes enabled bool Whether or not SAML is enabled for this organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSaml"},{"location":"v1/OrganizationSettingsSaml/#organizationsettingssaml","text":"Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.","title":"OrganizationSettingsSaml"},{"location":"v1/OrganizationSettingsSaml/#properties","text":"Name Type Description Notes enabled bool Whether or not SAML is enabled for this organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSamlAutocreateUsersDomains/","text":"OrganizationSettingsSamlAutocreateUsersDomains Has two properties, enabled (boolean) and domains , which is a list of domains without the @ symbol. Properties Name Type Description Notes domains [str] List of domains where the SAML automated user creation is enabled. [optional] enabled bool Whether or not the automated user creation based on SAML domain is enabled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSamlAutocreateUsersDomains"},{"location":"v1/OrganizationSettingsSamlAutocreateUsersDomains/#organizationsettingssamlautocreateusersdomains","text":"Has two properties, enabled (boolean) and domains , which is a list of domains without the @ symbol.","title":"OrganizationSettingsSamlAutocreateUsersDomains"},{"location":"v1/OrganizationSettingsSamlAutocreateUsersDomains/#properties","text":"Name Type Description Notes domains [str] List of domains where the SAML automated user creation is enabled. [optional] enabled bool Whether or not the automated user creation based on SAML domain is enabled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSamlIdpInitiatedLogin/","text":"OrganizationSettingsSamlIdpInitiatedLogin Has one property enabled (boolean). Properties Name Type Description Notes enabled bool Whether SAML IdP initiated login is enabled, learn more in the SAML documentation . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSamlIdpInitiatedLogin"},{"location":"v1/OrganizationSettingsSamlIdpInitiatedLogin/#organizationsettingssamlidpinitiatedlogin","text":"Has one property enabled (boolean).","title":"OrganizationSettingsSamlIdpInitiatedLogin"},{"location":"v1/OrganizationSettingsSamlIdpInitiatedLogin/#properties","text":"Name Type Description Notes enabled bool Whether SAML IdP initiated login is enabled, learn more in the SAML documentation . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSamlStrictMode/","text":"OrganizationSettingsSamlStrictMode Has one property enabled (boolean). Properties Name Type Description Notes enabled bool 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSamlStrictMode"},{"location":"v1/OrganizationSettingsSamlStrictMode/#organizationsettingssamlstrictmode","text":"Has one property enabled (boolean).","title":"OrganizationSettingsSamlStrictMode"},{"location":"v1/OrganizationSettingsSamlStrictMode/#properties","text":"Name Type Description Notes enabled bool 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSubscription/","text":"OrganizationSubscription Subscription definition. Properties Name Type Description Notes type str The subscription type. Types available are `trial`, `free`, and `pro`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSubscription"},{"location":"v1/OrganizationSubscription/#organizationsubscription","text":"Subscription definition.","title":"OrganizationSubscription"},{"location":"v1/OrganizationSubscription/#properties","text":"Name Type Description Notes type str The subscription type. Types available are `trial`, `free`, and `pro`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationsApi/","text":"datadog_api_client.v1.OrganizationsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_child_org POST /api/v1/org Create a child organization get_org GET /api/v1/org/{public_id} Get organization information list_orgs GET /api/v1/org List your managed organizations update_org PUT /api/v1/org/{public_id} Update your organization upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata create_child_org OrganizationCreateResponse create_child_org(body) Create a child organization Create a child organization. This endpoint requires the multi-organization account feature and must be enabled by contacting support . Once a new child organization is created, you can interact with it by using the org.public_id , pi_key.key , and application_key.hash provided in the response. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) body = OrganizationCreateBody( billing=OrganizationBilling( type=\"type_example\", ), name=\"New child org\", subscription=OrganizationSubscription( type=\"type_example\", ), ) # OrganizationCreateBody | Organization object that needs to be created # example passing only required values which don't have defaults set try: # Create a child organization api_response = api_instance.create_child_org(body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->create_child_org: %s\\n\" % e) Parameters Name Type Description Notes body OrganizationCreateBody Organization object that needs to be created Return type OrganizationCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_org OrganizationResponse get_org(public_id) Get organization information Get organization information. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. # example passing only required values which don't have defaults set try: # Get organization information api_response = api_instance.get_org(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->get_org: %s\\n\" % e) Parameters Name Type Description Notes public_id str The `public_id` of the organization you are operating within. Return type OrganizationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_orgs OrganizationListResponse list_orgs() List your managed organizations List your managed organizations. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) # example, this endpoint has no required or optional parameters try: # List your managed organizations api_response = api_instance.list_orgs() pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->list_orgs: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type OrganizationListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_org OrganizationResponse update_org(public_id, body) Update your organization Update your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. body = Organization( billing=OrganizationBilling( type=\"type_example\", ), created=\"2019-09-26T17:28:28Z\", description=\"some description\", name=\"New child org\", public_id=\"abcdef12345\", settings=OrganizationSettings( private_widget_share=False, saml=OrganizationSettingsSaml( enabled=False, ), saml_autocreate_access_role=AccessRole(\"st\"), saml_autocreate_users_domains=OrganizationSettingsSamlAutocreateUsersDomains( domains=[ \"example.com\", ], enabled=False, ), saml_can_be_enabled=False, saml_idp_endpoint=\"https://my.saml.endpoint\", saml_idp_initiated_login=OrganizationSettingsSamlIdpInitiatedLogin( enabled=False, ), saml_idp_metadata_uploaded=False, saml_login_url=\"https://my.saml.login.url\", saml_strict_mode=OrganizationSettingsSamlStrictMode( enabled=False, ), ), subscription=OrganizationSubscription( type=\"type_example\", ), ) # Organization | # example passing only required values which don't have defaults set try: # Update your organization api_response = api_instance.update_org(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->update_org: %s\\n\" % e) Parameters Name Type Description Notes public_id str The `public_id` of the organization you are operating within. body Organization Return type OrganizationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] upload_id_p_for_org IdpResponse upload_id_p_for_org(public_id, idp_file) Upload IdP metadata 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. * XML Body: Post the IdP metadata file as the body of the request. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating with idp_file = open('/path/to/file', 'rb') # file_type | The path to the XML metadata file you wish to upload. # example passing only required values which don't have defaults set try: # Upload IdP metadata api_response = api_instance.upload_id_p_for_org(public_id, idp_file) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->upload_id_p_for_org: %s\\n\" % e) Parameters Name Type Description Notes public_id str The `public_id` of the organization you are operating with idp_file file_type The path to the XML metadata file you wish to upload. Return type IdpResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : multipart/form-data Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 415 Unsupported Media Type - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.OrganizationsApi"},{"location":"v1/OrganizationsApi/#datadog_api_clientv1organizationsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_child_org POST /api/v1/org Create a child organization get_org GET /api/v1/org/{public_id} Get organization information list_orgs GET /api/v1/org List your managed organizations update_org PUT /api/v1/org/{public_id} Update your organization upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata","title":"datadog_api_client.v1.OrganizationsApi"},{"location":"v1/OrganizationsApi/#create_child_org","text":"OrganizationCreateResponse create_child_org(body) Create a child organization Create a child organization. This endpoint requires the multi-organization account feature and must be enabled by contacting support . Once a new child organization is created, you can interact with it by using the org.public_id , pi_key.key , and application_key.hash provided in the response.","title":"create_child_org"},{"location":"v1/OrganizationsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) body = OrganizationCreateBody( billing=OrganizationBilling( type=\"type_example\", ), name=\"New child org\", subscription=OrganizationSubscription( type=\"type_example\", ), ) # OrganizationCreateBody | Organization object that needs to be created # example passing only required values which don't have defaults set try: # Create a child organization api_response = api_instance.create_child_org(body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->create_child_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters","text":"Name Type Description Notes body OrganizationCreateBody Organization object that needs to be created","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type","text":"OrganizationCreateResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#get_org","text":"OrganizationResponse get_org(public_id) Get organization information Get organization information.","title":"get_org"},{"location":"v1/OrganizationsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. # example passing only required values which don't have defaults set try: # Get organization information api_response = api_instance.get_org(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->get_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_1","text":"Name Type Description Notes public_id str The `public_id` of the organization you are operating within.","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_1","text":"OrganizationResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#list_orgs","text":"OrganizationListResponse list_orgs() List your managed organizations List your managed organizations.","title":"list_orgs"},{"location":"v1/OrganizationsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) # example, this endpoint has no required or optional parameters try: # List your managed organizations api_response = api_instance.list_orgs() pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->list_orgs: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_2","text":"OrganizationListResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#update_org","text":"OrganizationResponse update_org(public_id, body) Update your organization Update your organization.","title":"update_org"},{"location":"v1/OrganizationsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. body = Organization( billing=OrganizationBilling( type=\"type_example\", ), created=\"2019-09-26T17:28:28Z\", description=\"some description\", name=\"New child org\", public_id=\"abcdef12345\", settings=OrganizationSettings( private_widget_share=False, saml=OrganizationSettingsSaml( enabled=False, ), saml_autocreate_access_role=AccessRole(\"st\"), saml_autocreate_users_domains=OrganizationSettingsSamlAutocreateUsersDomains( domains=[ \"example.com\", ], enabled=False, ), saml_can_be_enabled=False, saml_idp_endpoint=\"https://my.saml.endpoint\", saml_idp_initiated_login=OrganizationSettingsSamlIdpInitiatedLogin( enabled=False, ), saml_idp_metadata_uploaded=False, saml_login_url=\"https://my.saml.login.url\", saml_strict_mode=OrganizationSettingsSamlStrictMode( enabled=False, ), ), subscription=OrganizationSubscription( type=\"type_example\", ), ) # Organization | # example passing only required values which don't have defaults set try: # Update your organization api_response = api_instance.update_org(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->update_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_3","text":"Name Type Description Notes public_id str The `public_id` of the organization you are operating within. body Organization","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_3","text":"OrganizationResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#upload_id_p_for_org","text":"IdpResponse upload_id_p_for_org(public_id, idp_file) Upload IdP metadata 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. * XML Body: Post the IdP metadata file as the body of the request.","title":"upload_id_p_for_org"},{"location":"v1/OrganizationsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating with idp_file = open('/path/to/file', 'rb') # file_type | The path to the XML metadata file you wish to upload. # example passing only required values which don't have defaults set try: # Upload IdP metadata api_response = api_instance.upload_id_p_for_org(public_id, idp_file) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->upload_id_p_for_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_4","text":"Name Type Description Notes public_id str The `public_id` of the organization you are operating with idp_file file_type The path to the XML metadata file you wish to upload.","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_4","text":"IdpResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_4","text":"Content-Type : multipart/form-data Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 415 Unsupported Media Type - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/","text":"datadog_api_client.v1.PagerDutyIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object create_pager_duty_integration_service PagerDutyServiceName create_pager_duty_integration_service(body) Create a new service object Create a new service object in the PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) body = PagerDutyService( service_key=\"\", service_name=\"\", ) # PagerDutyService | Create a new service object request body. # example passing only required values which don't have defaults set try: # Create a new service object api_response = api_instance.create_pager_duty_integration_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->create_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes body PagerDutyService Create a new service object request body. Return type PagerDutyServiceName Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_pager_duty_integration_service delete_pager_duty_integration_service(service_name) Delete a single service object Delete a single service object in the Datadog-PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name # example passing only required values which don't have defaults set try: # Delete a single service object api_instance.delete_pager_duty_integration_service(service_name) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->delete_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes service_name str The service name Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_pager_duty_integration_service PagerDutyServiceName get_pager_duty_integration_service(service_name) Get a single service object Get service name in the Datadog-PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name. # example passing only required values which don't have defaults set try: # Get a single service object api_response = api_instance.get_pager_duty_integration_service(service_name) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->get_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes service_name str The service name. Return type PagerDutyServiceName Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_pager_duty_integration_service update_pager_duty_integration_service(service_name, body) Update a single service object Update a single service object in the Datadog-PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name body = PagerDutyServiceKey( service_key=\"\", ) # PagerDutyServiceKey | Update an existing service object request body. # example passing only required values which don't have defaults set try: # Update a single service object api_instance.update_pager_duty_integration_service(service_name, body) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->update_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes service_name str The service name body PagerDutyServiceKey Update an existing service object request body. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.PagerDutyIntegrationApi"},{"location":"v1/PagerDutyIntegrationApi/#datadog_api_clientv1pagerdutyintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object","title":"datadog_api_client.v1.PagerDutyIntegrationApi"},{"location":"v1/PagerDutyIntegrationApi/#create_pager_duty_integration_service","text":"PagerDutyServiceName create_pager_duty_integration_service(body) Create a new service object Create a new service object in the PagerDuty integration.","title":"create_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) body = PagerDutyService( service_key=\"\", service_name=\"\", ) # PagerDutyService | Create a new service object request body. # example passing only required values which don't have defaults set try: # Create a new service object api_response = api_instance.create_pager_duty_integration_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->create_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters","text":"Name Type Description Notes body PagerDutyService Create a new service object request body.","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type","text":"PagerDutyServiceName","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details","text":"Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/#delete_pager_duty_integration_service","text":"delete_pager_duty_integration_service(service_name) Delete a single service object Delete a single service object in the Datadog-PagerDuty integration.","title":"delete_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name # example passing only required values which don't have defaults set try: # Delete a single service object api_instance.delete_pager_duty_integration_service(service_name) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->delete_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters_1","text":"Name Type Description Notes service_name str The service name","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/#get_pager_duty_integration_service","text":"PagerDutyServiceName get_pager_duty_integration_service(service_name) Get a single service object Get service name in the Datadog-PagerDuty integration.","title":"get_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name. # example passing only required values which don't have defaults set try: # Get a single service object api_response = api_instance.get_pager_duty_integration_service(service_name) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->get_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters_2","text":"Name Type Description Notes service_name str The service name.","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type_2","text":"PagerDutyServiceName","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/#update_pager_duty_integration_service","text":"update_pager_duty_integration_service(service_name, body) Update a single service object Update a single service object in the Datadog-PagerDuty integration.","title":"update_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name body = PagerDutyServiceKey( service_key=\"\", ) # PagerDutyServiceKey | Update an existing service object request body. # example passing only required values which don't have defaults set try: # Update a single service object api_instance.update_pager_duty_integration_service(service_name, body) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->update_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters_3","text":"Name Type Description Notes service_name str The service name body PagerDutyServiceKey Update an existing service object request body.","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyService/","text":"PagerDutyService The PagerDuty service that is available for integration with Datadog. Properties Name Type Description Notes service_key str Your service key in PagerDuty. service_name str Your service name associated with a service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"PagerDutyService"},{"location":"v1/PagerDutyService/#pagerdutyservice","text":"The PagerDuty service that is available for integration with Datadog.","title":"PagerDutyService"},{"location":"v1/PagerDutyService/#properties","text":"Name Type Description Notes service_key str Your service key in PagerDuty. service_name str Your service name associated with a service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/PagerDutyServiceKey/","text":"PagerDutyServiceKey PagerDuty service object key. Properties Name Type Description Notes service_key str Your service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"PagerDutyServiceKey"},{"location":"v1/PagerDutyServiceKey/#pagerdutyservicekey","text":"PagerDuty service object key.","title":"PagerDutyServiceKey"},{"location":"v1/PagerDutyServiceKey/#properties","text":"Name Type Description Notes service_key str Your service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/PagerDutyServiceName/","text":"PagerDutyServiceName PagerDuty service object name. Properties Name Type Description Notes service_name str Your service name associated service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"PagerDutyServiceName"},{"location":"v1/PagerDutyServiceName/#pagerdutyservicename","text":"PagerDuty service object name.","title":"PagerDutyServiceName"},{"location":"v1/PagerDutyServiceName/#properties","text":"Name Type Description Notes service_name str Your service name associated service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Point/","text":"Point Array of timeseries points. Properties Name Type Description Notes value [float] Array of timeseries points. [Back to Model list] [Back to API list] [Back to README]","title":"Point"},{"location":"v1/Point/#point","text":"Array of timeseries points.","title":"Point"},{"location":"v1/Point/#properties","text":"Name Type Description Notes value [float] Array of timeseries points. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ProcessQueryDefinition/","text":"ProcessQueryDefinition The process query to use in the widget. Properties Name Type Description Notes metric str Your chosen metric. filter_by [str] List of processes. [optional] limit int Max number of items in the filter list. [optional] search_by str Your chosen search term. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessQueryDefinition"},{"location":"v1/ProcessQueryDefinition/#processquerydefinition","text":"The process query to use in the widget.","title":"ProcessQueryDefinition"},{"location":"v1/ProcessQueryDefinition/#properties","text":"Name Type Description Notes metric str Your chosen metric. filter_by [str] List of processes. [optional] limit int Max number of items in the filter list. [optional] search_by str Your chosen search term. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QuerySortOrder/","text":"QuerySortOrder Direction of sort. Properties Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"QuerySortOrder"},{"location":"v1/QuerySortOrder/#querysortorder","text":"Direction of sort.","title":"QuerySortOrder"},{"location":"v1/QuerySortOrder/#properties","text":"Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QueryValueWidgetDefinition/","text":"QueryValueWidgetDefinition Query values display the current value of a given metric, APM, or log query. Properties Name Type Description Notes requests [QueryValueWidgetRequest] Widget definition. type QueryValueWidgetDefinitionType autoscale bool Whether to use auto-scaling or not. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] custom_unit str Display a unit of your choice on the widget. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"QueryValueWidgetDefinition"},{"location":"v1/QueryValueWidgetDefinition/#queryvaluewidgetdefinition","text":"Query values display the current value of a given metric, APM, or log query.","title":"QueryValueWidgetDefinition"},{"location":"v1/QueryValueWidgetDefinition/#properties","text":"Name Type Description Notes requests [QueryValueWidgetRequest] Widget definition. type QueryValueWidgetDefinitionType autoscale bool Whether to use auto-scaling or not. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] custom_unit str Display a unit of your choice on the widget. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QueryValueWidgetDefinitionType/","text":"QueryValueWidgetDefinitionType Type of the query value widget. Properties Name Type Description Notes value str Type of the query value widget. defaults to \"query_value\", must be one of [\"query_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"QueryValueWidgetDefinitionType"},{"location":"v1/QueryValueWidgetDefinitionType/#queryvaluewidgetdefinitiontype","text":"Type of the query value widget.","title":"QueryValueWidgetDefinitionType"},{"location":"v1/QueryValueWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the query value widget. defaults to \"query_value\", must be one of [\"query_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QueryValueWidgetRequest/","text":"QueryValueWidgetRequest Updated query value widget. Properties Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str TODO. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"QueryValueWidgetRequest"},{"location":"v1/QueryValueWidgetRequest/#queryvaluewidgetrequest","text":"Updated query value widget.","title":"QueryValueWidgetRequest"},{"location":"v1/QueryValueWidgetRequest/#properties","text":"Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str TODO. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDelete/","text":"SLOBulkDelete A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID. Properties Name Type Description Notes any string name [SLOTimeframe] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDelete"},{"location":"v1/SLOBulkDelete/#slobulkdelete","text":"A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID.","title":"SLOBulkDelete"},{"location":"v1/SLOBulkDelete/#properties","text":"Name Type Description Notes any string name [SLOTimeframe] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDeleteError/","text":"SLOBulkDeleteError Object describing the error. Properties Name Type Description Notes id str The ID of the service level objective object associated with this error. message str The error message. timeframe SLOErrorTimeframe [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDeleteError"},{"location":"v1/SLOBulkDeleteError/#slobulkdeleteerror","text":"Object describing the error.","title":"SLOBulkDeleteError"},{"location":"v1/SLOBulkDeleteError/#properties","text":"Name Type Description Notes id str The ID of the service level objective object associated with this error. message str The error message. timeframe SLOErrorTimeframe [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDeleteResponse/","text":"SLOBulkDeleteResponse The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the \\\"data\\\" and \\\"error\\\" fields in this response indicate which deletions succeeded and failed. Properties Name Type Description Notes data SLOBulkDeleteResponseData [optional] errors [SLOBulkDeleteError] Array of errors object returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDeleteResponse"},{"location":"v1/SLOBulkDeleteResponse/#slobulkdeleteresponse","text":"The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the \\\"data\\\" and \\\"error\\\" fields in this response indicate which deletions succeeded and failed.","title":"SLOBulkDeleteResponse"},{"location":"v1/SLOBulkDeleteResponse/#properties","text":"Name Type Description Notes data SLOBulkDeleteResponseData [optional] errors [SLOBulkDeleteError] Array of errors object returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDeleteResponseData/","text":"SLOBulkDeleteResponseData An array of service level objective objects. Properties Name Type Description Notes deleted [str] An array of service level objective object IDs that indicates which objects that were completely deleted. [optional] updated [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDeleteResponseData"},{"location":"v1/SLOBulkDeleteResponseData/#slobulkdeleteresponsedata","text":"An array of service level objective objects.","title":"SLOBulkDeleteResponseData"},{"location":"v1/SLOBulkDeleteResponseData/#properties","text":"Name Type Description Notes deleted [str] An array of service level objective object IDs that indicates which objects that were completely deleted. [optional] updated [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrection/","text":"SLOCorrection The response object of a list of SLO corrections Properties Name Type Description Notes attributes SLOCorrectionResponseAttributes [optional] id str The ID of the SLO correction [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrection"},{"location":"v1/SLOCorrection/#slocorrection","text":"The response object of a list of SLO corrections","title":"SLOCorrection"},{"location":"v1/SLOCorrection/#properties","text":"Name Type Description Notes attributes SLOCorrectionResponseAttributes [optional] id str The ID of the SLO correction [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCategory/","text":"SLOCorrectionCategory Category the SLO correction belongs to Properties Name Type Description Notes value str Category the SLO correction belongs to must be one of [\"Scheduled Maintenance\", \"Outside Business Hours\", \"Deployment\", \"Other\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCategory"},{"location":"v1/SLOCorrectionCategory/#slocorrectioncategory","text":"Category the SLO correction belongs to","title":"SLOCorrectionCategory"},{"location":"v1/SLOCorrectionCategory/#properties","text":"Name Type Description Notes value str Category the SLO correction belongs to must be one of [\"Scheduled Maintenance\", \"Outside Business Hours\", \"Deployment\", \"Other\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCreateData/","text":"SLOCorrectionCreateData The data object associated with the SLO correction to be created Properties Name Type Description Notes attributes SLOCorrectionCreateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCreateData"},{"location":"v1/SLOCorrectionCreateData/#slocorrectioncreatedata","text":"The data object associated with the SLO correction to be created","title":"SLOCorrectionCreateData"},{"location":"v1/SLOCorrectionCreateData/#properties","text":"Name Type Description Notes attributes SLOCorrectionCreateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCreateRequest/","text":"SLOCorrectionCreateRequest An object that defines a correction to be applied to an SLO Properties Name Type Description Notes data SLOCorrectionCreateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCreateRequest"},{"location":"v1/SLOCorrectionCreateRequest/#slocorrectioncreaterequest","text":"An object that defines a correction to be applied to an SLO","title":"SLOCorrectionCreateRequest"},{"location":"v1/SLOCorrectionCreateRequest/#properties","text":"Name Type Description Notes data SLOCorrectionCreateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCreateRequestAttributes/","text":"SLOCorrectionCreateRequestAttributes The attribute object associated with the SLO correction to be created Properties Name Type Description Notes category SLOCorrectionCategory end int Ending time of the correction in epoch seconds slo_id str ID of the SLO that this correction will be applied to start int Starting time of the correction in epoch seconds description str Description of the correction being made. [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCreateRequestAttributes"},{"location":"v1/SLOCorrectionCreateRequestAttributes/#slocorrectioncreaterequestattributes","text":"The attribute object associated with the SLO correction to be created","title":"SLOCorrectionCreateRequestAttributes"},{"location":"v1/SLOCorrectionCreateRequestAttributes/#properties","text":"Name Type Description Notes category SLOCorrectionCategory end int Ending time of the correction in epoch seconds slo_id str ID of the SLO that this correction will be applied to start int Starting time of the correction in epoch seconds description str Description of the correction being made. [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionListResponse/","text":"SLOCorrectionListResponse A list of SLO correction objects Properties Name Type Description Notes data [SLOCorrection] The list of of SLO corrections objects [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionListResponse"},{"location":"v1/SLOCorrectionListResponse/#slocorrectionlistresponse","text":"A list of SLO correction objects","title":"SLOCorrectionListResponse"},{"location":"v1/SLOCorrectionListResponse/#properties","text":"Name Type Description Notes data [SLOCorrection] The list of of SLO corrections objects [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionResponse/","text":"SLOCorrectionResponse The response object of an SLO correction Properties Name Type Description Notes data SLOCorrection [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionResponse"},{"location":"v1/SLOCorrectionResponse/#slocorrectionresponse","text":"The response object of an SLO correction","title":"SLOCorrectionResponse"},{"location":"v1/SLOCorrectionResponse/#properties","text":"Name Type Description Notes data SLOCorrection [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionResponseAttributes/","text":"SLOCorrectionResponseAttributes The attribute object associated with the SLO correction Properties Name Type Description Notes category SLOCorrectionCategory [optional] creator Creator [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] slo_id str ID of the SLO that this correction will be applied to [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionResponseAttributes"},{"location":"v1/SLOCorrectionResponseAttributes/#slocorrectionresponseattributes","text":"The attribute object associated with the SLO correction","title":"SLOCorrectionResponseAttributes"},{"location":"v1/SLOCorrectionResponseAttributes/#properties","text":"Name Type Description Notes category SLOCorrectionCategory [optional] creator Creator [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] slo_id str ID of the SLO that this correction will be applied to [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionType/","text":"SLOCorrectionType SLO correction resource type. Properties Name Type Description Notes value str SLO correction resource type. defaults to \"correction\", must be one of [\"correction\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionType"},{"location":"v1/SLOCorrectionType/#slocorrectiontype","text":"SLO correction resource type.","title":"SLOCorrectionType"},{"location":"v1/SLOCorrectionType/#properties","text":"Name Type Description Notes value str SLO correction resource type. defaults to \"correction\", must be one of [\"correction\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionUpdateData/","text":"SLOCorrectionUpdateData The data object associated with the SLO correction to be updated Properties Name Type Description Notes attributes SLOCorrectionUpdateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionUpdateData"},{"location":"v1/SLOCorrectionUpdateData/#slocorrectionupdatedata","text":"The data object associated with the SLO correction to be updated","title":"SLOCorrectionUpdateData"},{"location":"v1/SLOCorrectionUpdateData/#properties","text":"Name Type Description Notes attributes SLOCorrectionUpdateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionUpdateRequest/","text":"SLOCorrectionUpdateRequest An object that defines a correction to be applied to an SLO Properties Name Type Description Notes data SLOCorrectionUpdateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionUpdateRequest"},{"location":"v1/SLOCorrectionUpdateRequest/#slocorrectionupdaterequest","text":"An object that defines a correction to be applied to an SLO","title":"SLOCorrectionUpdateRequest"},{"location":"v1/SLOCorrectionUpdateRequest/#properties","text":"Name Type Description Notes data SLOCorrectionUpdateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionUpdateRequestAttributes/","text":"SLOCorrectionUpdateRequestAttributes The attribute object associated with the SLO correction to be updated Properties Name Type Description Notes category SLOCorrectionCategory [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionUpdateRequestAttributes"},{"location":"v1/SLOCorrectionUpdateRequestAttributes/#slocorrectionupdaterequestattributes","text":"The attribute object associated with the SLO correction to be updated","title":"SLOCorrectionUpdateRequestAttributes"},{"location":"v1/SLOCorrectionUpdateRequestAttributes/#properties","text":"Name Type Description Notes category SLOCorrectionCategory [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLODeleteResponse/","text":"SLODeleteResponse A response list of all service level objective deleted. Properties Name Type Description Notes data [str] An array containing the ID of the deleted service level objective object. [optional] errors {str: (str,)} An dictionary containing the ID of the SLO as key and a deletion error as value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLODeleteResponse"},{"location":"v1/SLODeleteResponse/#slodeleteresponse","text":"A response list of all service level objective deleted.","title":"SLODeleteResponse"},{"location":"v1/SLODeleteResponse/#properties","text":"Name Type Description Notes data [str] An array containing the ID of the deleted service level objective object. [optional] errors {str: (str,)} An dictionary containing the ID of the SLO as key and a deletion error as value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOErrorBudgetRemainingData/","text":"SLOErrorBudgetRemainingData A mapping of threshold timeframe to the remaining error budget. Properties Name Type Description Notes any string name float any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOErrorBudgetRemainingData"},{"location":"v1/SLOErrorBudgetRemainingData/#sloerrorbudgetremainingdata","text":"A mapping of threshold timeframe to the remaining error budget.","title":"SLOErrorBudgetRemainingData"},{"location":"v1/SLOErrorBudgetRemainingData/#properties","text":"Name Type Description Notes any string name float any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOErrorTimeframe/","text":"SLOErrorTimeframe The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected. Properties Name Type Description Notes value str The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected. must be one of [\"7d\", \"30d\", \"90d\", \"all\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOErrorTimeframe"},{"location":"v1/SLOErrorTimeframe/#sloerrortimeframe","text":"The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected.","title":"SLOErrorTimeframe"},{"location":"v1/SLOErrorTimeframe/#properties","text":"Name Type Description Notes value str The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected. must be one of [\"7d\", \"30d\", \"90d\", \"all\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetrics/","text":"SLOHistoryMetrics A metric based SLO history response. This is not included in responses for monitor based SLOs. Properties Name Type Description Notes denominator SLOHistoryMetricsSeries interval int The aggregated query interval for the series data. It's implicit based on the query time window. numerator SLOHistoryMetricsSeries query str The combined numerator and denominator query CSV. res_type str The series result type. This mimics `batch_query` response type. resp_version int The series response version type. This mimics `batch_query` response type. times [float] An array of query timestamps in EPOCH milliseconds message str Optional message if there are specific query issues/warnings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetrics"},{"location":"v1/SLOHistoryMetrics/#slohistorymetrics","text":"A metric based SLO history response. This is not included in responses for monitor based SLOs.","title":"SLOHistoryMetrics"},{"location":"v1/SLOHistoryMetrics/#properties","text":"Name Type Description Notes denominator SLOHistoryMetricsSeries interval int The aggregated query interval for the series data. It's implicit based on the query time window. numerator SLOHistoryMetricsSeries query str The combined numerator and denominator query CSV. res_type str The series result type. This mimics `batch_query` response type. resp_version int The series response version type. This mimics `batch_query` response type. times [float] An array of query timestamps in EPOCH milliseconds message str Optional message if there are specific query issues/warnings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetricsSeries/","text":"SLOHistoryMetricsSeries A representation of metric based SLO time series for the provided queries. This is the same response type from batch_query endpoint. Properties Name Type Description Notes count int Count of submitted metrics. metadata SLOHistoryMetricsSeriesMetadata sum float Total sum of the query. values [float] The query values for each metric. [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetricsSeries"},{"location":"v1/SLOHistoryMetricsSeries/#slohistorymetricsseries","text":"A representation of metric based SLO time series for the provided queries. This is the same response type from batch_query endpoint.","title":"SLOHistoryMetricsSeries"},{"location":"v1/SLOHistoryMetricsSeries/#properties","text":"Name Type Description Notes count int Count of submitted metrics. metadata SLOHistoryMetricsSeriesMetadata sum float Total sum of the query. values [float] The query values for each metric. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetricsSeriesMetadata/","text":"SLOHistoryMetricsSeriesMetadata Query metadata. Properties Name Type Description Notes aggr str Query aggregator function. [optional] expression str Query expression. [optional] metric str Query metric used. [optional] query_index int Query index from original combined query. [optional] scope str Query scope. [optional] unit [SLOHistoryMetricsSeriesMetadataUnit], none_type 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetricsSeriesMetadata"},{"location":"v1/SLOHistoryMetricsSeriesMetadata/#slohistorymetricsseriesmetadata","text":"Query metadata.","title":"SLOHistoryMetricsSeriesMetadata"},{"location":"v1/SLOHistoryMetricsSeriesMetadata/#properties","text":"Name Type Description Notes aggr str Query aggregator function. [optional] expression str Query expression. [optional] metric str Query metric used. [optional] query_index int Query index from original combined query. [optional] scope str Query scope. [optional] unit [SLOHistoryMetricsSeriesMetadataUnit], none_type 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetricsSeriesMetadataUnit/","text":"SLOHistoryMetricsSeriesMetadataUnit An Object of metric units. Properties Name Type Description Notes family str The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. [optional] id int The ID of the metric unit. [optional] name str The unit of the metric, for instance `byte`. [optional] plural str, none_type 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 str, none_type A shorter and abbreviated version of the metric unit, for instance `B`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetricsSeriesMetadataUnit"},{"location":"v1/SLOHistoryMetricsSeriesMetadataUnit/#slohistorymetricsseriesmetadataunit","text":"An Object of metric units.","title":"SLOHistoryMetricsSeriesMetadataUnit"},{"location":"v1/SLOHistoryMetricsSeriesMetadataUnit/#properties","text":"Name Type Description Notes family str The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. [optional] id int The ID of the metric unit. [optional] name str The unit of the metric, for instance `byte`. [optional] plural str, none_type 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 str, none_type A shorter and abbreviated version of the metric unit, for instance `B`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryResponse/","text":"SLOHistoryResponse A service level objective history response. Properties Name Type Description Notes data SLOHistoryResponseData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryResponse"},{"location":"v1/SLOHistoryResponse/#slohistoryresponse","text":"A service level objective history response.","title":"SLOHistoryResponse"},{"location":"v1/SLOHistoryResponse/#properties","text":"Name Type Description Notes data SLOHistoryResponseData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryResponseData/","text":"SLOHistoryResponseData An array of service level objective objects. Properties Name Type Description Notes from_ts int The `from` timestamp in epoch seconds. [optional] group_by [str] 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 [SLOHistorySLIData] For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. [optional] monitors [SLOHistorySLIData] 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 [optional] series SLOHistoryMetrics [optional] thresholds {str: (SLOThreshold,)} mapping of string timeframe to the SLO threshold. [optional] to_ts int The `to` timestamp in epoch seconds. [optional] type SLOType [optional] type_id SLOTypeNumeric [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryResponseData"},{"location":"v1/SLOHistoryResponseData/#slohistoryresponsedata","text":"An array of service level objective objects.","title":"SLOHistoryResponseData"},{"location":"v1/SLOHistoryResponseData/#properties","text":"Name Type Description Notes from_ts int The `from` timestamp in epoch seconds. [optional] group_by [str] 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 [SLOHistorySLIData] For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. [optional] monitors [SLOHistorySLIData] 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 [optional] series SLOHistoryMetrics [optional] thresholds {str: (SLOThreshold,)} mapping of string timeframe to the SLO threshold. [optional] to_ts int The `to` timestamp in epoch seconds. [optional] type SLOType [optional] type_id SLOTypeNumeric [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryResponseError/","text":"SLOHistoryResponseError A service level objective response containing the requested history. Properties Name Type Description Notes error str Human readable error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryResponseError"},{"location":"v1/SLOHistoryResponseError/#slohistoryresponseerror","text":"A service level objective response containing the requested history.","title":"SLOHistoryResponseError"},{"location":"v1/SLOHistoryResponseError/#properties","text":"Name Type Description Notes error str Human readable error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistorySLIData/","text":"SLOHistorySLIData An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs. Properties Name Type Description Notes error_budget_remaining SLOErrorBudgetRemainingData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] group str For groups in a grouped SLO, this is the group name. [optional] history [[float]] For `monitor` based SLOs, this includes the aggregated history uptime time series. [optional] monitor_modified int For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. [optional] monitor_type str For `monitor` based SLOs, this describes the type of monitor. [optional] name str 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 {str: (float,)} A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. [optional] preview bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistorySLIData"},{"location":"v1/SLOHistorySLIData/#slohistoryslidata","text":"An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.","title":"SLOHistorySLIData"},{"location":"v1/SLOHistorySLIData/#properties","text":"Name Type Description Notes error_budget_remaining SLOErrorBudgetRemainingData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] group str For groups in a grouped SLO, this is the group name. [optional] history [[float]] For `monitor` based SLOs, this includes the aggregated history uptime time series. [optional] monitor_modified int For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. [optional] monitor_type str For `monitor` based SLOs, this describes the type of monitor. [optional] name str 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 {str: (float,)} A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. [optional] preview bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOListResponse/","text":"SLOListResponse A response with one or more service level objective. Properties Name Type Description Notes data [ServiceLevelObjective] An array of service level objective objects. [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] metadata SLOListResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOListResponse"},{"location":"v1/SLOListResponse/#slolistresponse","text":"A response with one or more service level objective.","title":"SLOListResponse"},{"location":"v1/SLOListResponse/#properties","text":"Name Type Description Notes data [ServiceLevelObjective] An array of service level objective objects. [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] metadata SLOListResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOListResponseMetadata/","text":"SLOListResponseMetadata The metadata object containing additional information about the list of SLOs. Properties Name Type Description Notes page SLOListResponseMetadataPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOListResponseMetadata"},{"location":"v1/SLOListResponseMetadata/#slolistresponsemetadata","text":"The metadata object containing additional information about the list of SLOs.","title":"SLOListResponseMetadata"},{"location":"v1/SLOListResponseMetadata/#properties","text":"Name Type Description Notes page SLOListResponseMetadataPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOListResponseMetadataPage/","text":"SLOListResponseMetadataPage The object containing information about the pages of the list of SLOs. Properties Name Type Description Notes total_count int The total number of resources that could be retrieved ignoring the parameters and filters in the request. [optional] total_filtered_count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOListResponseMetadataPage"},{"location":"v1/SLOListResponseMetadataPage/#slolistresponsemetadatapage","text":"The object containing information about the pages of the list of SLOs.","title":"SLOListResponseMetadataPage"},{"location":"v1/SLOListResponseMetadataPage/#properties","text":"Name Type Description Notes total_count int The total number of resources that could be retrieved ignoring the parameters and filters in the request. [optional] total_filtered_count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOResponse/","text":"SLOResponse A service level objective response containing a single service level objective. Properties Name Type Description Notes data SLOResponseData [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOResponse"},{"location":"v1/SLOResponse/#sloresponse","text":"A service level objective response containing a single service level objective.","title":"SLOResponse"},{"location":"v1/SLOResponse/#properties","text":"Name Type Description Notes data SLOResponseData [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOResponseData/","text":"SLOResponseData A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.). Properties Name Type Description Notes configured_alert_ids [int] 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 int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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 str The name of the service level objective object. [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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 [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. [optional] type SLOType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOResponseData"},{"location":"v1/SLOResponseData/#sloresponsedata","text":"A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.).","title":"SLOResponseData"},{"location":"v1/SLOResponseData/#properties","text":"Name Type Description Notes configured_alert_ids [int] 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 int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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 str The name of the service level objective object. [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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 [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. [optional] type SLOType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOThreshold/","text":"SLOThreshold SLO thresholds (target and optionally warning) for a single time window. Properties Name Type Description Notes target float The target value for the service level indicator within the corresponding timeframe. timeframe SLOTimeframe target_display str 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] warning float The warning value for the service level objective. [optional] warning_display str 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOThreshold"},{"location":"v1/SLOThreshold/#slothreshold","text":"SLO thresholds (target and optionally warning) for a single time window.","title":"SLOThreshold"},{"location":"v1/SLOThreshold/#properties","text":"Name Type Description Notes target float The target value for the service level indicator within the corresponding timeframe. timeframe SLOTimeframe target_display str 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] warning float The warning value for the service level objective. [optional] warning_display str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOTimeframe/","text":"SLOTimeframe The SLO time window options. Properties Name Type Description Notes value str The SLO time window options. must be one of [\"7d\", \"30d\", \"90d\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOTimeframe"},{"location":"v1/SLOTimeframe/#slotimeframe","text":"The SLO time window options.","title":"SLOTimeframe"},{"location":"v1/SLOTimeframe/#properties","text":"Name Type Description Notes value str The SLO time window options. must be one of [\"7d\", \"30d\", \"90d\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOType/","text":"SLOType The type of the service level objective. Properties Name Type Description Notes value str The type of the service level objective. must be one of [\"metric\", \"monitor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOType"},{"location":"v1/SLOType/#slotype","text":"The type of the service level objective.","title":"SLOType"},{"location":"v1/SLOType/#properties","text":"Name Type Description Notes value str The type of the service level objective. must be one of [\"metric\", \"monitor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOTypeNumeric/","text":"SLOTypeNumeric A numeric representation of the type of the service level objective ( 0 for monitor, 1 for metric). Always included in service level objective responses. Ignored in create/update requests. Properties Name Type Description Notes value int A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. must be one of [0, 1, ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOTypeNumeric"},{"location":"v1/SLOTypeNumeric/#slotypenumeric","text":"A numeric representation of the type of the service level objective ( 0 for monitor, 1 for metric). Always included in service level objective responses. Ignored in create/update requests.","title":"SLOTypeNumeric"},{"location":"v1/SLOTypeNumeric/#properties","text":"Name Type Description Notes value int A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. must be one of [0, 1, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOWidgetDefinition/","text":"SLOWidgetDefinition Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards. Properties Name Type Description Notes type SLOWidgetDefinitionType view_type str Type of view displayed by the widget. defaults to \"detail\" global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] view_mode WidgetViewMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOWidgetDefinition"},{"location":"v1/SLOWidgetDefinition/#slowidgetdefinition","text":"Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.","title":"SLOWidgetDefinition"},{"location":"v1/SLOWidgetDefinition/#properties","text":"Name Type Description Notes type SLOWidgetDefinitionType view_type str Type of view displayed by the widget. defaults to \"detail\" global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] view_mode WidgetViewMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOWidgetDefinitionType/","text":"SLOWidgetDefinitionType Type of the SLO widget. Properties Name Type Description Notes value str Type of the SLO widget. defaults to \"slo\", must be one of [\"slo\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOWidgetDefinitionType"},{"location":"v1/SLOWidgetDefinitionType/#slowidgetdefinitiontype","text":"Type of the SLO widget.","title":"SLOWidgetDefinitionType"},{"location":"v1/SLOWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the SLO widget. defaults to \"slo\", must be one of [\"slo\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotRequest/","text":"ScatterPlotRequest Updated scatter plot. Properties Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotRequest"},{"location":"v1/ScatterPlotRequest/#scatterplotrequest","text":"Updated scatter plot.","title":"ScatterPlotRequest"},{"location":"v1/ScatterPlotRequest/#properties","text":"Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotWidgetDefinition/","text":"ScatterPlotWidgetDefinition The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. Properties Name Type Description Notes requests ScatterPlotWidgetDefinitionRequests type ScatterPlotWidgetDefinitionType color_by_groups [str] List of groups used for colors. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotWidgetDefinition"},{"location":"v1/ScatterPlotWidgetDefinition/#scatterplotwidgetdefinition","text":"The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.","title":"ScatterPlotWidgetDefinition"},{"location":"v1/ScatterPlotWidgetDefinition/#properties","text":"Name Type Description Notes requests ScatterPlotWidgetDefinitionRequests type ScatterPlotWidgetDefinitionType color_by_groups [str] List of groups used for colors. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotWidgetDefinitionRequests/","text":"ScatterPlotWidgetDefinitionRequests Widget definition. Properties Name Type Description Notes x ScatterPlotRequest y ScatterPlotRequest [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotWidgetDefinitionRequests"},{"location":"v1/ScatterPlotWidgetDefinitionRequests/#scatterplotwidgetdefinitionrequests","text":"Widget definition.","title":"ScatterPlotWidgetDefinitionRequests"},{"location":"v1/ScatterPlotWidgetDefinitionRequests/#properties","text":"Name Type Description Notes x ScatterPlotRequest y ScatterPlotRequest [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotWidgetDefinitionType/","text":"ScatterPlotWidgetDefinitionType Type of the scatter plot widget. Properties Name Type Description Notes value str Type of the scatter plot widget. defaults to \"scatterplot\", must be one of [\"scatterplot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotWidgetDefinitionType"},{"location":"v1/ScatterPlotWidgetDefinitionType/#scatterplotwidgetdefinitiontype","text":"Type of the scatter plot widget.","title":"ScatterPlotWidgetDefinitionType"},{"location":"v1/ScatterPlotWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the scatter plot widget. defaults to \"scatterplot\", must be one of [\"scatterplot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Series/","text":"Series A metric to submit to Datadog. See Datadog metrics . Properties Name Type Description Notes metric str The name of the timeseries. points [Point] 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. host str The name of the host that produced the metric. [optional] interval int, none_type If the type of the metric is rate or count, define the corresponding interval. [optional] tags [str] A list of tags associated with the metric. [optional] type str The type of the metric either `count`, `gauge`, or `rate`. [optional] if omitted the server will use the default value of \"gauge\" [Back to Model list] [Back to API list] [Back to README]","title":"Series"},{"location":"v1/Series/#series","text":"A metric to submit to Datadog. See Datadog metrics .","title":"Series"},{"location":"v1/Series/#properties","text":"Name Type Description Notes metric str The name of the timeseries. points [Point] 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. host str The name of the host that produced the metric. [optional] interval int, none_type If the type of the metric is rate or count, define the corresponding interval. [optional] tags [str] A list of tags associated with the metric. [optional] type str The type of the metric either `count`, `gauge`, or `rate`. [optional] if omitted the server will use the default value of \"gauge\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceCheck/","text":"ServiceCheck An object containing service check and status. Properties Name Type Description Notes check str The check. host_name str The host name correlated with the check. status ServiceCheckStatus tags [str] Tags related to a check. message str Message containing check status. [optional] timestamp int Time of check. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceCheck"},{"location":"v1/ServiceCheck/#servicecheck","text":"An object containing service check and status.","title":"ServiceCheck"},{"location":"v1/ServiceCheck/#properties","text":"Name Type Description Notes check str The check. host_name str The host name correlated with the check. status ServiceCheckStatus tags [str] Tags related to a check. message str Message containing check status. [optional] timestamp int Time of check. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceCheckStatus/","text":"ServiceCheckStatus The status of a service check. Properties Name Type Description Notes value int The status of a service check. must be one of [0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceCheckStatus"},{"location":"v1/ServiceCheckStatus/#servicecheckstatus","text":"The status of a service check.","title":"ServiceCheckStatus"},{"location":"v1/ServiceCheckStatus/#properties","text":"Name Type Description Notes value int The status of a service check. must be one of [0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceChecks/","text":"ServiceChecks The service checks. Properties Name Type Description Notes value [ServiceCheck] The service checks. [Back to Model list] [Back to API list] [Back to README]","title":"ServiceChecks"},{"location":"v1/ServiceChecks/#servicechecks","text":"The service checks.","title":"ServiceChecks"},{"location":"v1/ServiceChecks/#properties","text":"Name Type Description Notes value [ServiceCheck] The service checks. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceChecksApi/","text":"datadog_api_client.v1.ServiceChecksApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description submit_service_check POST /api/v1/check_run Submit a Service Check submit_service_check IntakePayloadAccepted submit_service_check(body) Submit a Service Check Submit a list of Service Checks. Note : A valid API key is required. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_checks_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_checks_api.ServiceChecksApi(api_client) body = ServiceChecks([ ServiceCheck( check=\"app.ok\", host_name=\"app.host1\", message=\"app is running\", status=ServiceCheckStatus(0), tags=[\"environment:test\"], timestamp=1, ), ]) # ServiceChecks | Service Check request body. # example passing only required values which don't have defaults set try: # Submit a Service Check api_response = api_instance.submit_service_check(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceChecksApi->submit_service_check: %s\\n\" % e) Parameters Name Type Description Notes body ServiceChecks Service Check request body. Return type IntakePayloadAccepted Authorization apiKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication Error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.ServiceChecksApi"},{"location":"v1/ServiceChecksApi/#datadog_api_clientv1servicechecksapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description submit_service_check POST /api/v1/check_run Submit a Service Check","title":"datadog_api_client.v1.ServiceChecksApi"},{"location":"v1/ServiceChecksApi/#submit_service_check","text":"IntakePayloadAccepted submit_service_check(body) Submit a Service Check Submit a list of Service Checks. Note : A valid API key is required.","title":"submit_service_check"},{"location":"v1/ServiceChecksApi/#example","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_checks_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_checks_api.ServiceChecksApi(api_client) body = ServiceChecks([ ServiceCheck( check=\"app.ok\", host_name=\"app.host1\", message=\"app is running\", status=ServiceCheckStatus(0), tags=[\"environment:test\"], timestamp=1, ), ]) # ServiceChecks | Service Check request body. # example passing only required values which don't have defaults set try: # Submit a Service Check api_response = api_instance.submit_service_check(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceChecksApi->submit_service_check: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceChecksApi/#parameters","text":"Name Type Description Notes body ServiceChecks Service Check request body.","title":"Parameters"},{"location":"v1/ServiceChecksApi/#return-type","text":"IntakePayloadAccepted","title":"Return type"},{"location":"v1/ServiceChecksApi/#authorization","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/ServiceChecksApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceChecksApi/#http-response-details","text":"Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication Error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjective/","text":"ServiceLevelObjective A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.). Properties Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceLevelObjective"},{"location":"v1/ServiceLevelObjective/#servicelevelobjective","text":"A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.).","title":"ServiceLevelObjective"},{"location":"v1/ServiceLevelObjective/#properties","text":"Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/","text":"datadog_api_client.v1.ServiceLevelObjectiveCorrectionsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slo_correction POST /api/v1/slo/correction Create an SLO correction delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO list_slo_correction GET /api/v1/slo/correction Get all SLO corrections update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction create_slo_correction SLOCorrectionResponse create_slo_correction(body) Create an SLO correction Create an SLO Correction Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) body = SLOCorrectionCreateRequest( data=SLOCorrectionCreateData( attributes=SLOCorrectionCreateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, slo_id=\"sloId\", start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionCreateRequest | Create an SLO Correction # example passing only required values which don't have defaults set try: # Create an SLO correction api_response = api_instance.create_slo_correction(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->create_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes body SLOCorrectionCreateRequest Create an SLO Correction Return type SLOCorrectionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_slo_correction delete_slo_correction(slo_correction_id) Delete an SLO correction Permanently delete the specified SLO correction object Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Delete an SLO correction api_instance.delete_slo_correction(slo_correction_id) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->delete_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes slo_correction_id str The ID of the SLO correction object Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slo_correction SLOCorrectionResponse get_slo_correction(slo_correction_id) Get an SLO correction for an SLO Get an SLO correction Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Get an SLO correction for an SLO api_response = api_instance.get_slo_correction(slo_correction_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->get_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes slo_correction_id str The ID of the SLO correction object Return type SLOCorrectionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_slo_correction SLOCorrectionListResponse list_slo_correction() Get all SLO corrections Get all Service Level Objective corrections Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all SLO corrections api_response = api_instance.list_slo_correction() pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->list_slo_correction: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type SLOCorrectionListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_slo_correction SLOCorrectionResponse update_slo_correction(slo_correction_id, body) Update an SLO correction Update the specified SLO correction object object Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object body = SLOCorrectionUpdateRequest( data=SLOCorrectionUpdateData( attributes=SLOCorrectionUpdateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionUpdateRequest | The edited SLO correction object. # example passing only required values which don't have defaults set try: # Update an SLO correction api_response = api_instance.update_slo_correction(slo_correction_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->update_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes slo_correction_id str The ID of the SLO correction object body SLOCorrectionUpdateRequest The edited SLO correction object. Return type SLOCorrectionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.ServiceLevelObjectiveCorrectionsApi"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#datadog_api_clientv1servicelevelobjectivecorrectionsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slo_correction POST /api/v1/slo/correction Create an SLO correction delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO list_slo_correction GET /api/v1/slo/correction Get all SLO corrections update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction","title":"datadog_api_client.v1.ServiceLevelObjectiveCorrectionsApi"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#create_slo_correction","text":"SLOCorrectionResponse create_slo_correction(body) Create an SLO correction Create an SLO Correction","title":"create_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) body = SLOCorrectionCreateRequest( data=SLOCorrectionCreateData( attributes=SLOCorrectionCreateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, slo_id=\"sloId\", start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionCreateRequest | Create an SLO Correction # example passing only required values which don't have defaults set try: # Create an SLO correction api_response = api_instance.create_slo_correction(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->create_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters","text":"Name Type Description Notes body SLOCorrectionCreateRequest Create an SLO Correction","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type","text":"SLOCorrectionResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#delete_slo_correction","text":"delete_slo_correction(slo_correction_id) Delete an SLO correction Permanently delete the specified SLO correction object","title":"delete_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Delete an SLO correction api_instance.delete_slo_correction(slo_correction_id) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->delete_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_1","text":"Name Type Description Notes slo_correction_id str The ID of the SLO correction object","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#get_slo_correction","text":"SLOCorrectionResponse get_slo_correction(slo_correction_id) Get an SLO correction for an SLO Get an SLO correction","title":"get_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Get an SLO correction for an SLO api_response = api_instance.get_slo_correction(slo_correction_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->get_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_2","text":"Name Type Description Notes slo_correction_id str The ID of the SLO correction object","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_2","text":"SLOCorrectionResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#list_slo_correction","text":"SLOCorrectionListResponse list_slo_correction() Get all SLO corrections Get all Service Level Objective corrections","title":"list_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all SLO corrections api_response = api_instance.list_slo_correction() pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->list_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_3","text":"SLOCorrectionListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#update_slo_correction","text":"SLOCorrectionResponse update_slo_correction(slo_correction_id, body) Update an SLO correction Update the specified SLO correction object object","title":"update_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object body = SLOCorrectionUpdateRequest( data=SLOCorrectionUpdateData( attributes=SLOCorrectionUpdateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionUpdateRequest | The edited SLO correction object. # example passing only required values which don't have defaults set try: # Update an SLO correction api_response = api_instance.update_slo_correction(slo_correction_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->update_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_4","text":"Name Type Description Notes slo_correction_id str The ID of the SLO correction object body SLOCorrectionUpdateRequest The edited SLO correction object.","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_4","text":"SLOCorrectionResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveQuery/","text":"ServiceLevelObjectiveQuery A metric SLI query. Required if type is metric . Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests. Properties Name Type Description Notes denominator str A Datadog metric query for total (valid) events. numerator str A Datadog metric query for good events. [Back to Model list] [Back to API list] [Back to README]","title":"ServiceLevelObjectiveQuery"},{"location":"v1/ServiceLevelObjectiveQuery/#servicelevelobjectivequery","text":"A metric SLI query. Required if type is metric . Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.","title":"ServiceLevelObjectiveQuery"},{"location":"v1/ServiceLevelObjectiveQuery/#properties","text":"Name Type Description Notes denominator str A Datadog metric query for total (valid) events. numerator str A Datadog metric query for good events. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceLevelObjectiveRequest/","text":"ServiceLevelObjectiveRequest A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.). Properties Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType description str, none_type 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 [str] 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 [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceLevelObjectiveRequest"},{"location":"v1/ServiceLevelObjectiveRequest/#servicelevelobjectiverequest","text":"A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.).","title":"ServiceLevelObjectiveRequest"},{"location":"v1/ServiceLevelObjectiveRequest/#properties","text":"Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType description str, none_type 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 [str] 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 [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceLevelObjectivesApi/","text":"datadog_api_client.v1.ServiceLevelObjectivesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted create_slo POST /api/v1/slo Create an SLO object delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes get_slo GET /api/v1/slo/{slo_id} Get an SLO's details get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history list_slos GET /api/v1/slo Get all SLOs update_slo PUT /api/v1/slo/{slo_id} Update an SLO check_can_delete_slo CheckCanDeleteSLOResponse check_can_delete_slo(ids) Check if SLOs can be safely deleted Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. # example passing only required values which don't have defaults set try: # Check if SLOs can be safely deleted api_response = api_instance.check_can_delete_slo(ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->check_can_delete_slo: %s\\n\" % e) Parameters Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects. Return type CheckCanDeleteSLOResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_slo SLOListResponse create_slo(body) Create an SLO object Create a service level objective object. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = ServiceLevelObjectiveRequest( description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], monitor_ids=[ 1, ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjectiveRequest | Service level objective request object. # example passing only required values which don't have defaults set try: # Create an SLO object api_response = api_instance.create_slo(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->create_slo: %s\\n\" % e) Parameters Name Type Description Notes body ServiceLevelObjectiveRequest Service level objective request object. Return type SLOListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_slo SLODeleteResponse delete_slo(slo_id) Delete an SLO Permanently delete the specified service level objective object. If an SLO is used in a dashboard, the DELETE /v1/slo/ endpoint returns a 409 conflict error because the SLO is referenced in a dashboard. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete an SLO api_response = api_instance.delete_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete an SLO api_response = api_instance.delete_slo(slo_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional] Return type SLODeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_slo_timeframe_in_bulk SLOBulkDeleteResponse delete_slo_timeframe_in_bulk(body) Bulk Delete SLO Timeframes Delete (or partially delete) multiple service level objective objects. This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = SLOBulkDelete( key=[ SLOTimeframe(\"7d\"), ], ) # SLOBulkDelete | Delete multiple service level objective objects request body. # example passing only required values which don't have defaults set try: # Bulk Delete SLO Timeframes api_response = api_instance.delete_slo_timeframe_in_bulk(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo_timeframe_in_bulk: %s\\n\" % e) Parameters Name Type Description Notes body SLOBulkDelete Delete multiple service level objective objects request body. Return type SLOBulkDeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slo SLOResponse get_slo(slo_id) Get an SLO's details Get a service level objective object. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. with_configured_alert_ids = True # bool | Get the IDs of SLO monitors that reference this SLO. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's details api_response = api_instance.get_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's details api_response = api_instance.get_slo(slo_id, with_configured_alert_ids=with_configured_alert_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective object. with_configured_alert_ids bool Get the IDs of SLO monitors that reference this SLO. [optional] Return type SLOResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slo_history SLOHistoryResponse get_slo_history(slo_id, from_ts, to_ts) Get an SLO's history Get a specific SLO\u2019s history, regardless of its SLO type. The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history. Note: There are different response formats for event based and time based SLOs. Examples of both are shown. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_history\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. from_ts = 1 # int | The `from` timestamp for the query window in epoch seconds. to_ts = 1 # int | The `to` timestamp for the query window in epoch seconds. target = 0 # float | The SLO target. If `target` is passed in, the response will include the error budget that remains. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts, target=target) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective object. from_ts int The `from` timestamp for the query window in epoch seconds. to_ts int 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 error budget that remains. [optional] Return type SLOHistoryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_slos SLOListResponse list_slos() Get all SLOs Get a list of service level objective objects for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. (optional) query = \"monitor\" # str | The query string to filter results based on SLO names. (optional) tags_query = \"env:prod\" # str | The query string to filter results based on a single SLO tag. (optional) metrics_query = \"aws.elb.request_count\" # str | The query string to filter results based on SLO numerator and denominator. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all SLOs api_response = api_instance.list_slos(ids=ids, query=query, tags_query=tags_query, metrics_query=metrics_query) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->list_slos: %s\\n\" % e) Parameters Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects. [optional] query str The query string to filter results based on SLO names. [optional] tags_query str The query string to filter results based on a single SLO tag. [optional] metrics_query str The query string to filter results based on SLO numerator and denominator. [optional] Return type SLOListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_slo SLOListResponse update_slo(slo_id, body) Update an SLO Update the specified service level objective object. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. body = ServiceLevelObjective( created_at=1, creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], id=\"id_example\", modified_at=1, monitor_ids=[ 1, ], monitor_tags=[ \"monitor_tags_example\", ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjective | The edited service level objective request object. # example passing only required values which don't have defaults set try: # Update an SLO api_response = api_instance.update_slo(slo_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->update_slo: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective object. body ServiceLevelObjective The edited service level objective request object. Return type SLOListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.ServiceLevelObjectivesApi"},{"location":"v1/ServiceLevelObjectivesApi/#datadog_api_clientv1servicelevelobjectivesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted create_slo POST /api/v1/slo Create an SLO object delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes get_slo GET /api/v1/slo/{slo_id} Get an SLO's details get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history list_slos GET /api/v1/slo Get all SLOs update_slo PUT /api/v1/slo/{slo_id} Update an SLO","title":"datadog_api_client.v1.ServiceLevelObjectivesApi"},{"location":"v1/ServiceLevelObjectivesApi/#check_can_delete_slo","text":"CheckCanDeleteSLOResponse check_can_delete_slo(ids) Check if SLOs can be safely deleted Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard.","title":"check_can_delete_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. # example passing only required values which don't have defaults set try: # Check if SLOs can be safely deleted api_response = api_instance.check_can_delete_slo(ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->check_can_delete_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters","text":"Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type","text":"CheckCanDeleteSLOResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#create_slo","text":"SLOListResponse create_slo(body) Create an SLO object Create a service level objective object.","title":"create_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = ServiceLevelObjectiveRequest( description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], monitor_ids=[ 1, ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjectiveRequest | Service level objective request object. # example passing only required values which don't have defaults set try: # Create an SLO object api_response = api_instance.create_slo(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->create_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_1","text":"Name Type Description Notes body ServiceLevelObjectiveRequest Service level objective request object.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_1","text":"SLOListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#delete_slo","text":"SLODeleteResponse delete_slo(slo_id) Delete an SLO Permanently delete the specified service level objective object. If an SLO is used in a dashboard, the DELETE /v1/slo/ endpoint returns a 409 conflict error because the SLO is referenced in a dashboard.","title":"delete_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete an SLO api_response = api_instance.delete_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete an SLO api_response = api_instance.delete_slo(slo_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_2","text":"Name Type Description Notes slo_id str The ID of the service level objective. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_2","text":"SLODeleteResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#delete_slo_timeframe_in_bulk","text":"SLOBulkDeleteResponse delete_slo_timeframe_in_bulk(body) Bulk Delete SLO Timeframes Delete (or partially delete) multiple service level objective objects. This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well.","title":"delete_slo_timeframe_in_bulk"},{"location":"v1/ServiceLevelObjectivesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = SLOBulkDelete( key=[ SLOTimeframe(\"7d\"), ], ) # SLOBulkDelete | Delete multiple service level objective objects request body. # example passing only required values which don't have defaults set try: # Bulk Delete SLO Timeframes api_response = api_instance.delete_slo_timeframe_in_bulk(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo_timeframe_in_bulk: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_3","text":"Name Type Description Notes body SLOBulkDelete Delete multiple service level objective objects request body.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_3","text":"SLOBulkDeleteResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#get_slo","text":"SLOResponse get_slo(slo_id) Get an SLO's details Get a service level objective object.","title":"get_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. with_configured_alert_ids = True # bool | Get the IDs of SLO monitors that reference this SLO. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's details api_response = api_instance.get_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's details api_response = api_instance.get_slo(slo_id, with_configured_alert_ids=with_configured_alert_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_4","text":"Name Type Description Notes slo_id str The ID of the service level objective object. with_configured_alert_ids bool Get the IDs of SLO monitors that reference this SLO. [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_4","text":"SLOResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#get_slo_history","text":"SLOHistoryResponse get_slo_history(slo_id, from_ts, to_ts) Get an SLO's history Get a specific SLO\u2019s history, regardless of its SLO type. The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history. Note: There are different response formats for event based and time based SLOs. Examples of both are shown.","title":"get_slo_history"},{"location":"v1/ServiceLevelObjectivesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_history\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. from_ts = 1 # int | The `from` timestamp for the query window in epoch seconds. to_ts = 1 # int | The `to` timestamp for the query window in epoch seconds. target = 0 # float | The SLO target. If `target` is passed in, the response will include the error budget that remains. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts, target=target) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_5","text":"Name Type Description Notes slo_id str The ID of the service level objective object. from_ts int The `from` timestamp for the query window in epoch seconds. to_ts int 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 error budget that remains. [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_5","text":"SLOHistoryResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#list_slos","text":"SLOListResponse list_slos() Get all SLOs Get a list of service level objective objects for your organization.","title":"list_slos"},{"location":"v1/ServiceLevelObjectivesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. (optional) query = \"monitor\" # str | The query string to filter results based on SLO names. (optional) tags_query = \"env:prod\" # str | The query string to filter results based on a single SLO tag. (optional) metrics_query = \"aws.elb.request_count\" # str | The query string to filter results based on SLO numerator and denominator. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all SLOs api_response = api_instance.list_slos(ids=ids, query=query, tags_query=tags_query, metrics_query=metrics_query) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->list_slos: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_6","text":"Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects. [optional] query str The query string to filter results based on SLO names. [optional] tags_query str The query string to filter results based on a single SLO tag. [optional] metrics_query str The query string to filter results based on SLO numerator and denominator. [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_6","text":"SLOListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#update_slo","text":"SLOListResponse update_slo(slo_id, body) Update an SLO Update the specified service level objective object.","title":"update_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. body = ServiceLevelObjective( created_at=1, creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], id=\"id_example\", modified_at=1, monitor_ids=[ 1, ], monitor_tags=[ \"monitor_tags_example\", ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjective | The edited service level objective request object. # example passing only required values which don't have defaults set try: # Update an SLO api_response = api_instance.update_slo(slo_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->update_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_7","text":"Name Type Description Notes slo_id str The ID of the service level objective object. body ServiceLevelObjective The edited service level objective request object.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_7","text":"SLOListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceMapWidgetDefinition/","text":"ServiceMapWidgetDefinition This widget displays a map of a service to all of the services that call it, and all of the services that it calls. Properties Name Type Description Notes filters [str] Your environment and primary tag (or * if enabled for your account). service str The ID of the service you want to map. type ServiceMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceMapWidgetDefinition"},{"location":"v1/ServiceMapWidgetDefinition/#servicemapwidgetdefinition","text":"This widget displays a map of a service to all of the services that call it, and all of the services that it calls.","title":"ServiceMapWidgetDefinition"},{"location":"v1/ServiceMapWidgetDefinition/#properties","text":"Name Type Description Notes filters [str] Your environment and primary tag (or * if enabled for your account). service str The ID of the service you want to map. type ServiceMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceMapWidgetDefinitionType/","text":"ServiceMapWidgetDefinitionType Type of the service map widget. Properties Name Type Description Notes value str Type of the service map widget. defaults to \"servicemap\", must be one of [\"servicemap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceMapWidgetDefinitionType"},{"location":"v1/ServiceMapWidgetDefinitionType/#servicemapwidgetdefinitiontype","text":"Type of the service map widget.","title":"ServiceMapWidgetDefinitionType"},{"location":"v1/ServiceMapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the service map widget. defaults to \"servicemap\", must be one of [\"servicemap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceSummaryWidgetDefinition/","text":"ServiceSummaryWidgetDefinition The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards. Properties Name Type Description Notes env str APM environment. service str APM service. span_name str APM span name. type ServiceSummaryWidgetDefinitionType display_format WidgetServiceSummaryDisplayFormat [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceSummaryWidgetDefinition"},{"location":"v1/ServiceSummaryWidgetDefinition/#servicesummarywidgetdefinition","text":"The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.","title":"ServiceSummaryWidgetDefinition"},{"location":"v1/ServiceSummaryWidgetDefinition/#properties","text":"Name Type Description Notes env str APM environment. service str APM service. span_name str APM span name. type ServiceSummaryWidgetDefinitionType display_format WidgetServiceSummaryDisplayFormat [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceSummaryWidgetDefinitionType/","text":"ServiceSummaryWidgetDefinitionType Type of the service summary widget. Properties Name Type Description Notes value str Type of the service summary widget. defaults to \"trace_service\", must be one of [\"trace_service\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceSummaryWidgetDefinitionType"},{"location":"v1/ServiceSummaryWidgetDefinitionType/#servicesummarywidgetdefinitiontype","text":"Type of the service summary widget.","title":"ServiceSummaryWidgetDefinitionType"},{"location":"v1/ServiceSummaryWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the service summary widget. defaults to \"trace_service\", must be one of [\"trace_service\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SlackIntegrationApi/","text":"datadog_api_client.v1.SlackIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel 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 GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration 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 PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel create_slack_integration_channel SlackIntegrationChannel create_slack_integration_channel(account_name, body) Create a Slack integration channel Add a channel to your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing Slack channel to be created # example passing only required values which don't have defaults set try: # Create a Slack integration channel api_response = api_instance.create_slack_integration_channel(account_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->create_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. body SlackIntegrationChannel Payload describing Slack channel to be created Return type SlackIntegrationChannel Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slack_integration_channel SlackIntegrationChannel get_slack_integration_channel(account_name, channel_name) Get a Slack integration channel Get a channel configured for your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Get a Slack integration channel api_response = api_instance.get_slack_integration_channel(account_name, channel_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. Return type SlackIntegrationChannel Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slack_integration_channels SlackIntegrationChannels get_slack_integration_channels(account_name) Get all channels in a Slack integration Get a list of all channels configured for your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. # example passing only required values which don't have defaults set try: # Get all channels in a Slack integration api_response = api_instance.get_slack_integration_channels(account_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channels: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. Return type SlackIntegrationChannels Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_slack_integration_channel remove_slack_integration_channel(account_name, channel_name) Remove a Slack integration channel Remove a channel from your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Remove a Slack integration channel api_instance.remove_slack_integration_channel(account_name, channel_name) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->remove_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 The channel was removed successfully. - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_slack_integration_channel SlackIntegrationChannel update_slack_integration_channel(account_name, channel_name, body) Update a Slack integration channel Update a channel used in your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing fields and values to be updated. # example passing only required values which don't have defaults set try: # Update a Slack integration channel api_response = api_instance.update_slack_integration_channel(account_name, channel_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->update_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. body SlackIntegrationChannel Payload describing fields and values to be updated. Return type SlackIntegrationChannel Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.SlackIntegrationApi"},{"location":"v1/SlackIntegrationApi/#datadog_api_clientv1slackintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel 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 GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration 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 PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel","title":"datadog_api_client.v1.SlackIntegrationApi"},{"location":"v1/SlackIntegrationApi/#create_slack_integration_channel","text":"SlackIntegrationChannel create_slack_integration_channel(account_name, body) Create a Slack integration channel Add a channel to your Datadog-Slack integration.","title":"create_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing Slack channel to be created # example passing only required values which don't have defaults set try: # Create a Slack integration channel api_response = api_instance.create_slack_integration_channel(account_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->create_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters","text":"Name Type Description Notes account_name str Your Slack account name. body SlackIntegrationChannel Payload describing Slack channel to be created","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type","text":"SlackIntegrationChannel","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#get_slack_integration_channel","text":"SlackIntegrationChannel get_slack_integration_channel(account_name, channel_name) Get a Slack integration channel Get a channel configured for your Datadog-Slack integration.","title":"get_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Get a Slack integration channel api_response = api_instance.get_slack_integration_channel(account_name, channel_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_1","text":"Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_1","text":"SlackIntegrationChannel","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#get_slack_integration_channels","text":"SlackIntegrationChannels get_slack_integration_channels(account_name) Get all channels in a Slack integration Get a list of all channels configured for your Datadog-Slack integration.","title":"get_slack_integration_channels"},{"location":"v1/SlackIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. # example passing only required values which don't have defaults set try: # Get all channels in a Slack integration api_response = api_instance.get_slack_integration_channels(account_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channels: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_2","text":"Name Type Description Notes account_name str Your Slack account name.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_2","text":"SlackIntegrationChannels","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#remove_slack_integration_channel","text":"remove_slack_integration_channel(account_name, channel_name) Remove a Slack integration channel Remove a channel from your Datadog-Slack integration.","title":"remove_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Remove a Slack integration channel api_instance.remove_slack_integration_channel(account_name, channel_name) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->remove_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_3","text":"Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 204 The channel was removed successfully. - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#update_slack_integration_channel","text":"SlackIntegrationChannel update_slack_integration_channel(account_name, channel_name, body) Update a Slack integration channel Update a channel used in your Datadog-Slack integration.","title":"update_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing fields and values to be updated. # example passing only required values which don't have defaults set try: # Update a Slack integration channel api_response = api_instance.update_slack_integration_channel(account_name, channel_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->update_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_4","text":"Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. body SlackIntegrationChannel Payload describing fields and values to be updated.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_4","text":"SlackIntegrationChannel","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationChannel/","text":"SlackIntegrationChannel The Slack channel configuration. Properties Name Type Description Notes display SlackIntegrationChannelDisplay [optional] name str Your channel name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SlackIntegrationChannel"},{"location":"v1/SlackIntegrationChannel/#slackintegrationchannel","text":"The Slack channel configuration.","title":"SlackIntegrationChannel"},{"location":"v1/SlackIntegrationChannel/#properties","text":"Name Type Description Notes display SlackIntegrationChannelDisplay [optional] name str Your channel name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SlackIntegrationChannelDisplay/","text":"SlackIntegrationChannelDisplay Configuration options for what is shown in an alert event message. Properties Name Type Description Notes message bool Show the main body of the alert event. [optional] if omitted the server will use the default value of True notified bool Show the list of @-handles in the alert event. [optional] if omitted the server will use the default value of True snapshot bool Show the alert event's snapshot image. [optional] if omitted the server will use the default value of True tags bool Show the scopes on which the monitor alerted. [optional] if omitted the server will use the default value of True [Back to Model list] [Back to API list] [Back to README]","title":"SlackIntegrationChannelDisplay"},{"location":"v1/SlackIntegrationChannelDisplay/#slackintegrationchanneldisplay","text":"Configuration options for what is shown in an alert event message.","title":"SlackIntegrationChannelDisplay"},{"location":"v1/SlackIntegrationChannelDisplay/#properties","text":"Name Type Description Notes message bool Show the main body of the alert event. [optional] if omitted the server will use the default value of True notified bool Show the list of @-handles in the alert event. [optional] if omitted the server will use the default value of True snapshot bool Show the alert event's snapshot image. [optional] if omitted the server will use the default value of True tags bool Show the scopes on which the monitor alerted. [optional] if omitted the server will use the default value of True [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SlackIntegrationChannels/","text":"SlackIntegrationChannels A list of configured Slack channels. Properties Name Type Description Notes value [SlackIntegrationChannel] A list of configured Slack channels. [Back to Model list] [Back to API list] [Back to README]","title":"SlackIntegrationChannels"},{"location":"v1/SlackIntegrationChannels/#slackintegrationchannels","text":"A list of configured Slack channels.","title":"SlackIntegrationChannels"},{"location":"v1/SlackIntegrationChannels/#properties","text":"Name Type Description Notes value [SlackIntegrationChannel] A list of configured Slack channels. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SnapshotsApi/","text":"datadog_api_client.v1.SnapshotsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots get_graph_snapshot GraphSnapshot get_graph_snapshot(start, end) Take graph snapshots Take graph snapshots. Note : When a snapshot is created, there is some delay before it is available. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import snapshots_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = snapshots_api.SnapshotsApi(api_client) start = 1 # int | The POSIX timestamp of the start of the query. end = 1 # int | The POSIX timestamp of the end of the query. metric_query = \"metric_query_example\" # str | The metric query. (optional) event_query = \"event_query_example\" # str | A query that adds event bands to the graph. (optional) graph_def = \"graph_def_example\" # str | 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 = \"title_example\" # str | A title for the graph. If no title is specified, the graph does not have a title. (optional) # example passing only required values which don't have defaults set try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end, metric_query=metric_query, event_query=event_query, graph_def=graph_def, title=title) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e) Parameters Name Type Description Notes start int The POSIX timestamp of the start of the query. end int The POSIX timestamp of the end of the query. metric_query str The metric query. [optional] event_query str A query that adds event bands to the graph. [optional] graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] title str A title for the graph. If no title is specified, the graph does not have a title. [optional] Return type GraphSnapshot Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.SnapshotsApi"},{"location":"v1/SnapshotsApi/#datadog_api_clientv1snapshotsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots","title":"datadog_api_client.v1.SnapshotsApi"},{"location":"v1/SnapshotsApi/#get_graph_snapshot","text":"GraphSnapshot get_graph_snapshot(start, end) Take graph snapshots Take graph snapshots. Note : When a snapshot is created, there is some delay before it is available.","title":"get_graph_snapshot"},{"location":"v1/SnapshotsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import snapshots_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = snapshots_api.SnapshotsApi(api_client) start = 1 # int | The POSIX timestamp of the start of the query. end = 1 # int | The POSIX timestamp of the end of the query. metric_query = \"metric_query_example\" # str | The metric query. (optional) event_query = \"event_query_example\" # str | A query that adds event bands to the graph. (optional) graph_def = \"graph_def_example\" # str | 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 = \"title_example\" # str | A title for the graph. If no title is specified, the graph does not have a title. (optional) # example passing only required values which don't have defaults set try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end, metric_query=metric_query, event_query=event_query, graph_def=graph_def, title=title) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e)","title":"Example"},{"location":"v1/SnapshotsApi/#parameters","text":"Name Type Description Notes start int The POSIX timestamp of the start of the query. end int The POSIX timestamp of the end of the query. metric_query str The metric query. [optional] event_query str A query that adds event bands to the graph. [optional] graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] title str A title for the graph. If no title is specified, the graph does not have a title. [optional]","title":"Parameters"},{"location":"v1/SnapshotsApi/#return-type","text":"GraphSnapshot","title":"Return type"},{"location":"v1/SnapshotsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SnapshotsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SnapshotsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsAPIStep/","text":"SyntheticsAPIStep The steps used in a Synthetics multistep API test. Properties Name Type Description Notes allow_failure bool Determines whether or not to continue with test if this step fails. [optional] assertions [SyntheticsAssertion] Array of assertions used for the test. [optional] if omitted the server will use the default value of [] extracted_values [SyntheticsParsingOptions] Array of values to parse and save as variables from the response. [optional] is_critical bool 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 str The name of the step. [optional] request SyntheticsTestRequest [optional] subtype SyntheticsAPIStepSubtype [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPIStep"},{"location":"v1/SyntheticsAPIStep/#syntheticsapistep","text":"The steps used in a Synthetics multistep API test.","title":"SyntheticsAPIStep"},{"location":"v1/SyntheticsAPIStep/#properties","text":"Name Type Description Notes allow_failure bool Determines whether or not to continue with test if this step fails. [optional] assertions [SyntheticsAssertion] Array of assertions used for the test. [optional] if omitted the server will use the default value of [] extracted_values [SyntheticsParsingOptions] Array of values to parse and save as variables from the response. [optional] is_critical bool 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 str The name of the step. [optional] request SyntheticsTestRequest [optional] subtype SyntheticsAPIStepSubtype [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPIStepSubtype/","text":"SyntheticsAPIStepSubtype The subtype of the Synthetic multistep API test step, currently only supporting http . Properties Name Type Description Notes value str The subtype of the Synthetic multistep API test step, currently only supporting `http`. defaults to \"http\", must be one of [\"http\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPIStepSubtype"},{"location":"v1/SyntheticsAPIStepSubtype/#syntheticsapistepsubtype","text":"The subtype of the Synthetic multistep API test step, currently only supporting http .","title":"SyntheticsAPIStepSubtype"},{"location":"v1/SyntheticsAPIStepSubtype/#properties","text":"Name Type Description Notes value str The subtype of the Synthetic multistep API test step, currently only supporting `http`. defaults to \"http\", must be one of [\"http\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITest/","text":"SyntheticsAPITest Object containing details about a Synthetic API test. Properties Name Type Description Notes config SyntheticsAPITestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID for the test. [optional] status SyntheticsTestPauseStatus [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsAPITestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITest"},{"location":"v1/SyntheticsAPITest/#syntheticsapitest","text":"Object containing details about a Synthetic API test.","title":"SyntheticsAPITest"},{"location":"v1/SyntheticsAPITest/#properties","text":"Name Type Description Notes config SyntheticsAPITestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID for the test. [optional] status SyntheticsTestPauseStatus [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsAPITestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestConfig/","text":"SyntheticsAPITestConfig Configuration object for a Synthetic API test. Properties Name Type Description Notes assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] Array of variables used for the test. [optional] request SyntheticsTestRequest [optional] steps [SyntheticsAPIStep] When the test subtype is `multi`, the steps of the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestConfig"},{"location":"v1/SyntheticsAPITestConfig/#syntheticsapitestconfig","text":"Configuration object for a Synthetic API test.","title":"SyntheticsAPITestConfig"},{"location":"v1/SyntheticsAPITestConfig/#properties","text":"Name Type Description Notes assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] Array of variables used for the test. [optional] request SyntheticsTestRequest [optional] steps [SyntheticsAPIStep] When the test subtype is `multi`, the steps of the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultData/","text":"SyntheticsAPITestResultData Object containing results for your Synthetic API test. Properties Name Type Description Notes cert SyntheticsSSLCertificate [optional] error_code SyntheticsErrorCode [optional] error_message str The API test error message. [optional] event_type SyntheticsTestProcessStatus [optional] http_status_code int The API test HTTP status code. [optional] request_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Request header object used for the API test. [optional] response_body str Response body returned for the API test. [optional] response_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Response headers returned for the API test. [optional] response_size int Global size in byte of the API test response. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultData"},{"location":"v1/SyntheticsAPITestResultData/#syntheticsapitestresultdata","text":"Object containing results for your Synthetic API test.","title":"SyntheticsAPITestResultData"},{"location":"v1/SyntheticsAPITestResultData/#properties","text":"Name Type Description Notes cert SyntheticsSSLCertificate [optional] error_code SyntheticsErrorCode [optional] error_message str The API test error message. [optional] event_type SyntheticsTestProcessStatus [optional] http_status_code int The API test HTTP status code. [optional] request_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Request header object used for the API test. [optional] response_body str Response body returned for the API test. [optional] response_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Response headers returned for the API test. [optional] response_size int Global size in byte of the API test response. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultFull/","text":"SyntheticsAPITestResultFull Object returned describing a API test result. Properties Name Type Description Notes check SyntheticsAPITestResultFullCheck [optional] check_time float When the API test was conducted. [optional] check_version int Version of the API test used. [optional] probe_dc str Locations for which to query the API test results. [optional] result SyntheticsAPITestResultData [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultFull"},{"location":"v1/SyntheticsAPITestResultFull/#syntheticsapitestresultfull","text":"Object returned describing a API test result.","title":"SyntheticsAPITestResultFull"},{"location":"v1/SyntheticsAPITestResultFull/#properties","text":"Name Type Description Notes check SyntheticsAPITestResultFullCheck [optional] check_time float When the API test was conducted. [optional] check_version int Version of the API test used. [optional] probe_dc str Locations for which to query the API test results. [optional] result SyntheticsAPITestResultData [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultFullCheck/","text":"SyntheticsAPITestResultFullCheck Object describing the API test configuration. Properties Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultFullCheck"},{"location":"v1/SyntheticsAPITestResultFullCheck/#syntheticsapitestresultfullcheck","text":"Object describing the API test configuration.","title":"SyntheticsAPITestResultFullCheck"},{"location":"v1/SyntheticsAPITestResultFullCheck/#properties","text":"Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultShort/","text":"SyntheticsAPITestResultShort Object with the results of a single Synthetic API test. Properties Name Type Description Notes check_time float Last time the API test was performed. [optional] probe_dc str Location from which the API test was performed. [optional] result SyntheticsAPITestResultShortResult [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultShort"},{"location":"v1/SyntheticsAPITestResultShort/#syntheticsapitestresultshort","text":"Object with the results of a single Synthetic API test.","title":"SyntheticsAPITestResultShort"},{"location":"v1/SyntheticsAPITestResultShort/#properties","text":"Name Type Description Notes check_time float Last time the API test was performed. [optional] probe_dc str Location from which the API test was performed. [optional] result SyntheticsAPITestResultShortResult [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultShortResult/","text":"SyntheticsAPITestResultShortResult Result of the last API test run. Properties Name Type Description Notes passed bool Describes if the test run has passed or failed. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultShortResult"},{"location":"v1/SyntheticsAPITestResultShortResult/#syntheticsapitestresultshortresult","text":"Result of the last API test run.","title":"SyntheticsAPITestResultShortResult"},{"location":"v1/SyntheticsAPITestResultShortResult/#properties","text":"Name Type Description Notes passed bool Describes if the test run has passed or failed. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestType/","text":"SyntheticsAPITestType Type of the Synthetic test, api . Properties Name Type Description Notes value str Type of the Synthetic test, `api`. defaults to \"api\", must be one of [\"api\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestType"},{"location":"v1/SyntheticsAPITestType/#syntheticsapitesttype","text":"Type of the Synthetic test, api .","title":"SyntheticsAPITestType"},{"location":"v1/SyntheticsAPITestType/#properties","text":"Name Type Description Notes value str Type of the Synthetic test, `api`. defaults to \"api\", must be one of [\"api\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsApi/","text":"datadog_api_client.v1.SyntheticsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_global_variable POST /api/v1/synthetics/variables Create a global variable create_private_location POST /api/v1/synthetics/private-locations Create a private location create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location delete_tests POST /api/v1/synthetics/tests/delete Delete tests edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test 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 GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test 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 GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration list_locations GET /api/v1/synthetics/locations Get all locations (public and private) list_tests GET /api/v1/synthetics/tests Get the list of all tests trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test create_global_variable SyntheticsGlobalVariable create_global_variable(body) Create a global variable Create a Synthetics global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to create. # example passing only required values which don't have defaults set try: # Create a global variable api_response = api_instance.create_global_variable(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_global_variable: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsGlobalVariable Details of the global variable to create. Return type SyntheticsGlobalVariable Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_private_location SyntheticsPrivateLocationCreationResponse create_private_location(body) Create a private location Create a new Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to create. # example passing only required values which don't have defaults set try: # Create a private location api_response = api_instance.create_private_location(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_private_location: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsPrivateLocation Details of the private location to create. Return type SyntheticsPrivateLocationCreationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 402 Quota reached for private locations - 404 Private locations are not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_synthetics_api_test SyntheticsAPITest create_synthetics_api_test(body) Create an API test Create a Synthetic API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create an API test api_response = api_instance.create_synthetics_api_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_api_test: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsAPITest Details of the test to create. Return type SyntheticsAPITest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_synthetics_browser_test SyntheticsBrowserTest create_synthetics_browser_test(body) Create a browser test Create a Synthetic browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create a browser test api_response = api_instance.create_synthetics_browser_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_browser_test: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsBrowserTest Details of the test to create. Return type SyntheticsBrowserTest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_global_variable delete_global_variable(variable_id) Delete a global variable Delete a Synthetics global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Delete a global variable api_instance.delete_global_variable(variable_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_global_variable: %s\\n\" % e) Parameters Name Type Description Notes variable_id str The ID of the global variable. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 JSON format is wrong - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_private_location delete_private_location(location_id) Delete a private location Delete a Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Delete a private location api_instance.delete_private_location(location_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_private_location: %s\\n\" % e) Parameters Name Type Description Notes location_id str The ID of the private location. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_tests SyntheticsDeleteTestsResponse delete_tests(body) Delete tests Delete multiple Synthetic tests by ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsDeleteTestsPayload( public_ids=[], ) # SyntheticsDeleteTestsPayload | Public ID list of the Synthetic tests to be deleted. # example passing only required values which don't have defaults set try: # Delete tests api_response = api_instance.delete_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_tests: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsDeleteTestsPayload Public ID list of the Synthetic tests to be deleted. Return type SyntheticsDeleteTestsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK. - 400 - JSON format is wrong - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) - Some IDs are not owned by the user - 403 Forbidden - 404 - Tests to be deleted can't be found - Synthetics is not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] edit_global_variable SyntheticsGlobalVariable edit_global_variable(variable_id, body) Edit a global variable Edit a Synthetics global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to update. # example passing only required values which don't have defaults set try: # Edit a global variable api_response = api_instance.edit_global_variable(variable_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->edit_global_variable: %s\\n\" % e) Parameters Name Type Description Notes variable_id str The ID of the global variable. body SyntheticsGlobalVariable Details of the global variable to update. Return type SyntheticsGlobalVariable Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_test SyntheticsAPITest get_api_test(public_id) Get an API test Get the detailed configuration associated with a Synthetic API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get an API test api_response = api_instance.get_api_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. Return type SyntheticsAPITest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_test_latest_results SyntheticsGetAPITestLatestResultsResponse get_api_test_latest_results(public_id) Get an API test's latest results summaries Get the last 50 test results summaries for a given Synthetics API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional] Return type SyntheticsGetAPITestLatestResultsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_test_result SyntheticsAPITestResultFull get_api_test_result(public_id, result_id) Get an API test result Get a specific full result from a given (API) Synthetic test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the API test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get an API test result api_response = api_instance.get_api_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_result: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the API test to which the target result belongs. result_id str The ID of the result to get. Return type SyntheticsAPITestResultFull Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_browser_test SyntheticsBrowserTest get_browser_test(public_id) Get a browser test Get the detailed configuration (including steps) associated with a Synthetic browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a browser test api_response = api_instance.get_browser_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. Return type SyntheticsBrowserTest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_browser_test_latest_results SyntheticsGetBrowserTestLatestResultsResponse get_browser_test_latest_results(public_id) Get a browser test's latest results summaries Get the last 50 test results summaries for a given Synthetics Browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the browser test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional] Return type SyntheticsGetBrowserTestLatestResultsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_browser_test_result SyntheticsBrowserTestResultFull get_browser_test_result(public_id, result_id) Get a browser test result Get a specific full result from a given (browser) Synthetic test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get a browser test result api_response = api_instance.get_browser_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_result: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the browser test to which the target result belongs. result_id str The ID of the result to get. Return type SyntheticsBrowserTestResultFull Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_global_variable SyntheticsGlobalVariable get_global_variable(variable_id) Get a global variable Get the detailed configuration of a global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Get a global variable api_response = api_instance.get_global_variable(variable_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_global_variable: %s\\n\" % e) Parameters Name Type Description Notes variable_id str The ID of the global variable. Return type SyntheticsGlobalVariable Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_private_location SyntheticsPrivateLocation get_private_location(location_id) Get a private location Get a Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Get a private location api_response = api_instance.get_private_location(location_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_private_location: %s\\n\" % e) Parameters Name Type Description Notes location_id str The ID of the private location. Return type SyntheticsPrivateLocation Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 404 - Synthetic private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_test SyntheticsTestDetails get_test(public_id) Get a test configuration Get the detailed configuration associated with a Synthetics test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a test configuration api_response = api_instance.get_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. Return type SyntheticsTestDetails Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_locations SyntheticsLocations list_locations() Get all locations (public and private) Get the list of public and private locations available for Synthetic tests. No arguments required. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all locations (public and private) api_response = api_instance.list_locations() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_locations: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type SyntheticsLocations Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tests SyntheticsListTestsResponse list_tests() Get the list of all tests Get the list of all Synthetic tests. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get the list of all tests api_response = api_instance.list_tests() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_tests: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type SyntheticsListTestsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns the list of all Synthetic tests. - 403 Forbidden - 404 Synthetics is not activated for the user. - [Back to top] [Back to API list] [Back to Model list] [Back to README] trigger_ci_tests SyntheticsTriggerCITestsResponse trigger_ci_tests(body) Trigger tests from CI/CD pipelines Trigger a set of Synthetics tests for continuous integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsCITestBody( tests=[ SyntheticsCITest( allow_insecure_certificates=True, basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", body_type=\"body_type_example\", cookies=\"cookies_example\", device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], follow_redirects=True, headers=SyntheticsTestHeaders( key=\"key_example\", ), locations=[ \"locations_example\", ], metadata=SyntheticsCITestMetadata( ci=SyntheticsCITestMetadataCi( pipeline=\"pipeline_example\", provider=\"provider_example\", ), git=SyntheticsCITestMetadataGit( branch=\"branch_example\", commit_sha=\"commit_sha_example\", ), ), public_id=\"aaa-aaa-aaa\", retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), start_url=\"start_url_example\", variables={ \"key\": \"key_example\", }, ), ], ) # SyntheticsCITestBody | Details of the test to trigger. # example passing only required values which don't have defaults set try: # Trigger tests from CI/CD pipelines api_response = api_instance.trigger_ci_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->trigger_ci_tests: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsCITestBody Details of the test to trigger. Return type SyntheticsTriggerCITestsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 JSON format is wrong - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_api_test SyntheticsAPITest update_api_test(public_id, body) Edit an API test Edit the configuration of a Synthetic API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit an API test api_response = api_instance.update_api_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_api_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsAPITest New test details to be saved. Return type SyntheticsAPITest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_browser_test SyntheticsBrowserTest update_browser_test(public_id, body) Edit a browser test Edit the configuration of a Synthetic browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit a browser test api_response = api_instance.update_browser_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_browser_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsBrowserTest New test details to be saved. Return type SyntheticsBrowserTest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_private_location SyntheticsPrivateLocation update_private_location(location_id, body) Edit a private location Edit a Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to be updated. # example passing only required values which don't have defaults set try: # Edit a private location api_response = api_instance.update_private_location(location_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_private_location: %s\\n\" % e) Parameters Name Type Description Notes location_id str The ID of the private location. body SyntheticsPrivateLocation Details of the private location to be updated. Return type SyntheticsPrivateLocation Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_test_pause_status bool update_test_pause_status(public_id, body) Pause or start a test Pause or start a Synthetics test by changing the status. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the Synthetic test to update. body = SyntheticsUpdateTestPauseStatusPayload( new_status=SyntheticsTestPauseStatus(\"live\"), ) # SyntheticsUpdateTestPauseStatusPayload | Status to set the given Synthetic test to. # example passing only required values which don't have defaults set try: # Pause or start a test api_response = api_instance.update_test_pause_status(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_test_pause_status: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the Synthetic test to update. body SyntheticsUpdateTestPauseStatusPayload Status to set the given Synthetic test to. Return type bool Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns a boolean indicating if the update was successful. - 400 JSON format is wrong. - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.SyntheticsApi"},{"location":"v1/SyntheticsApi/#datadog_api_clientv1syntheticsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_global_variable POST /api/v1/synthetics/variables Create a global variable create_private_location POST /api/v1/synthetics/private-locations Create a private location create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location delete_tests POST /api/v1/synthetics/tests/delete Delete tests edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test 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 GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test 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 GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration list_locations GET /api/v1/synthetics/locations Get all locations (public and private) list_tests GET /api/v1/synthetics/tests Get the list of all tests trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test","title":"datadog_api_client.v1.SyntheticsApi"},{"location":"v1/SyntheticsApi/#create_global_variable","text":"SyntheticsGlobalVariable create_global_variable(body) Create a global variable Create a Synthetics global variable.","title":"create_global_variable"},{"location":"v1/SyntheticsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to create. # example passing only required values which don't have defaults set try: # Create a global variable api_response = api_instance.create_global_variable(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters","text":"Name Type Description Notes body SyntheticsGlobalVariable Details of the global variable to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type","text":"SyntheticsGlobalVariable","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#create_private_location","text":"SyntheticsPrivateLocationCreationResponse create_private_location(body) Create a private location Create a new Synthetics private location.","title":"create_private_location"},{"location":"v1/SyntheticsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to create. # example passing only required values which don't have defaults set try: # Create a private location api_response = api_instance.create_private_location(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_1","text":"Name Type Description Notes body SyntheticsPrivateLocation Details of the private location to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_1","text":"SyntheticsPrivateLocationCreationResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 402 Quota reached for private locations - 404 Private locations are not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#create_synthetics_api_test","text":"SyntheticsAPITest create_synthetics_api_test(body) Create an API test Create a Synthetic API test.","title":"create_synthetics_api_test"},{"location":"v1/SyntheticsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create an API test api_response = api_instance.create_synthetics_api_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_api_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_2","text":"Name Type Description Notes body SyntheticsAPITest Details of the test to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_2","text":"SyntheticsAPITest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#create_synthetics_browser_test","text":"SyntheticsBrowserTest create_synthetics_browser_test(body) Create a browser test Create a Synthetic browser test.","title":"create_synthetics_browser_test"},{"location":"v1/SyntheticsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create a browser test api_response = api_instance.create_synthetics_browser_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_browser_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_3","text":"Name Type Description Notes body SyntheticsBrowserTest Details of the test to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_3","text":"SyntheticsBrowserTest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#delete_global_variable","text":"delete_global_variable(variable_id) Delete a global variable Delete a Synthetics global variable.","title":"delete_global_variable"},{"location":"v1/SyntheticsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Delete a global variable api_instance.delete_global_variable(variable_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_4","text":"Name Type Description Notes variable_id str The ID of the global variable.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_4","text":"void (empty response body)","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 JSON format is wrong - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#delete_private_location","text":"delete_private_location(location_id) Delete a private location Delete a Synthetics private location.","title":"delete_private_location"},{"location":"v1/SyntheticsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Delete a private location api_instance.delete_private_location(location_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_5","text":"Name Type Description Notes location_id str The ID of the private location.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_5","text":"void (empty response body)","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_5","text":"Status code Description Response headers 204 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#delete_tests","text":"SyntheticsDeleteTestsResponse delete_tests(body) Delete tests Delete multiple Synthetic tests by ID.","title":"delete_tests"},{"location":"v1/SyntheticsApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsDeleteTestsPayload( public_ids=[], ) # SyntheticsDeleteTestsPayload | Public ID list of the Synthetic tests to be deleted. # example passing only required values which don't have defaults set try: # Delete tests api_response = api_instance.delete_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_tests: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_6","text":"Name Type Description Notes body SyntheticsDeleteTestsPayload Public ID list of the Synthetic tests to be deleted.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_6","text":"SyntheticsDeleteTestsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_6","text":"Status code Description Response headers 200 OK. - 400 - JSON format is wrong - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) - Some IDs are not owned by the user - 403 Forbidden - 404 - Tests to be deleted can't be found - Synthetics is not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#edit_global_variable","text":"SyntheticsGlobalVariable edit_global_variable(variable_id, body) Edit a global variable Edit a Synthetics global variable.","title":"edit_global_variable"},{"location":"v1/SyntheticsApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to update. # example passing only required values which don't have defaults set try: # Edit a global variable api_response = api_instance.edit_global_variable(variable_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->edit_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_7","text":"Name Type Description Notes variable_id str The ID of the global variable. body SyntheticsGlobalVariable Details of the global variable to update.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_7","text":"SyntheticsGlobalVariable","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_api_test","text":"SyntheticsAPITest get_api_test(public_id) Get an API test Get the detailed configuration associated with a Synthetic API test.","title":"get_api_test"},{"location":"v1/SyntheticsApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get an API test api_response = api_instance.get_api_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_8","text":"Name Type Description Notes public_id str The public ID of the test to get details from.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_8","text":"SyntheticsAPITest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_api_test_latest_results","text":"SyntheticsGetAPITestLatestResultsResponse get_api_test_latest_results(public_id) Get an API test's latest results summaries Get the last 50 test results summaries for a given Synthetics API test.","title":"get_api_test_latest_results"},{"location":"v1/SyntheticsApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_9","text":"Name Type Description Notes public_id str The public ID of the test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional]","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_9","text":"SyntheticsGetAPITestLatestResultsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_9","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_api_test_result","text":"SyntheticsAPITestResultFull get_api_test_result(public_id, result_id) Get an API test result Get a specific full result from a given (API) Synthetic test.","title":"get_api_test_result"},{"location":"v1/SyntheticsApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the API test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get an API test result api_response = api_instance.get_api_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_result: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_10","text":"Name Type Description Notes public_id str The public ID of the API test to which the target result belongs. result_id str The ID of the result to get.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_10","text":"SyntheticsAPITestResultFull","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_10","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_browser_test","text":"SyntheticsBrowserTest get_browser_test(public_id) Get a browser test Get the detailed configuration (including steps) associated with a Synthetic browser test.","title":"get_browser_test"},{"location":"v1/SyntheticsApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a browser test api_response = api_instance.get_browser_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_11","text":"Name Type Description Notes public_id str The public ID of the test to get details from.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_11","text":"SyntheticsBrowserTest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_11","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_browser_test_latest_results","text":"SyntheticsGetBrowserTestLatestResultsResponse get_browser_test_latest_results(public_id) Get a browser test's latest results summaries Get the last 50 test results summaries for a given Synthetics Browser test.","title":"get_browser_test_latest_results"},{"location":"v1/SyntheticsApi/#example_12","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_12","text":"Name Type Description Notes public_id str The public ID of the browser test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional]","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_12","text":"SyntheticsGetBrowserTestLatestResultsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_12","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_12","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_12","text":"Status code Description Response headers 200 OK - 403 forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_browser_test_result","text":"SyntheticsBrowserTestResultFull get_browser_test_result(public_id, result_id) Get a browser test result Get a specific full result from a given (browser) Synthetic test.","title":"get_browser_test_result"},{"location":"v1/SyntheticsApi/#example_13","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get a browser test result api_response = api_instance.get_browser_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_result: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_13","text":"Name Type Description Notes public_id str The public ID of the browser test to which the target result belongs. result_id str The ID of the result to get.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_13","text":"SyntheticsBrowserTestResultFull","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_13","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_13","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_13","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_global_variable","text":"SyntheticsGlobalVariable get_global_variable(variable_id) Get a global variable Get the detailed configuration of a global variable.","title":"get_global_variable"},{"location":"v1/SyntheticsApi/#example_14","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Get a global variable api_response = api_instance.get_global_variable(variable_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_14","text":"Name Type Description Notes variable_id str The ID of the global variable.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_14","text":"SyntheticsGlobalVariable","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_14","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_14","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_14","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_private_location","text":"SyntheticsPrivateLocation get_private_location(location_id) Get a private location Get a Synthetics private location.","title":"get_private_location"},{"location":"v1/SyntheticsApi/#example_15","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Get a private location api_response = api_instance.get_private_location(location_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_15","text":"Name Type Description Notes location_id str The ID of the private location.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_15","text":"SyntheticsPrivateLocation","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_15","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_15","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_15","text":"Status code Description Response headers 200 OK - 404 - Synthetic private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_test","text":"SyntheticsTestDetails get_test(public_id) Get a test configuration Get the detailed configuration associated with a Synthetics test.","title":"get_test"},{"location":"v1/SyntheticsApi/#example_16","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a test configuration api_response = api_instance.get_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_16","text":"Name Type Description Notes public_id str The public ID of the test to get details from.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_16","text":"SyntheticsTestDetails","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_16","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_16","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_16","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#list_locations","text":"SyntheticsLocations list_locations() Get all locations (public and private) Get the list of public and private locations available for Synthetic tests. No arguments required.","title":"list_locations"},{"location":"v1/SyntheticsApi/#example_17","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all locations (public and private) api_response = api_instance.list_locations() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_locations: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_17","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_17","text":"SyntheticsLocations","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_17","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_17","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_17","text":"Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#list_tests","text":"SyntheticsListTestsResponse list_tests() Get the list of all tests Get the list of all Synthetic tests.","title":"list_tests"},{"location":"v1/SyntheticsApi/#example_18","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get the list of all tests api_response = api_instance.list_tests() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_tests: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_18","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_18","text":"SyntheticsListTestsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_18","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_18","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_18","text":"Status code Description Response headers 200 OK - Returns the list of all Synthetic tests. - 403 Forbidden - 404 Synthetics is not activated for the user. - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#trigger_ci_tests","text":"SyntheticsTriggerCITestsResponse trigger_ci_tests(body) Trigger tests from CI/CD pipelines Trigger a set of Synthetics tests for continuous integration.","title":"trigger_ci_tests"},{"location":"v1/SyntheticsApi/#example_19","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsCITestBody( tests=[ SyntheticsCITest( allow_insecure_certificates=True, basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", body_type=\"body_type_example\", cookies=\"cookies_example\", device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], follow_redirects=True, headers=SyntheticsTestHeaders( key=\"key_example\", ), locations=[ \"locations_example\", ], metadata=SyntheticsCITestMetadata( ci=SyntheticsCITestMetadataCi( pipeline=\"pipeline_example\", provider=\"provider_example\", ), git=SyntheticsCITestMetadataGit( branch=\"branch_example\", commit_sha=\"commit_sha_example\", ), ), public_id=\"aaa-aaa-aaa\", retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), start_url=\"start_url_example\", variables={ \"key\": \"key_example\", }, ), ], ) # SyntheticsCITestBody | Details of the test to trigger. # example passing only required values which don't have defaults set try: # Trigger tests from CI/CD pipelines api_response = api_instance.trigger_ci_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->trigger_ci_tests: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_19","text":"Name Type Description Notes body SyntheticsCITestBody Details of the test to trigger.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_19","text":"SyntheticsTriggerCITestsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_19","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_19","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_19","text":"Status code Description Response headers 200 OK - 400 JSON format is wrong - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_api_test","text":"SyntheticsAPITest update_api_test(public_id, body) Edit an API test Edit the configuration of a Synthetic API test.","title":"update_api_test"},{"location":"v1/SyntheticsApi/#example_20","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit an API test api_response = api_instance.update_api_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_api_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_20","text":"Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsAPITest New test details to be saved.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_20","text":"SyntheticsAPITest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_20","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_20","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_20","text":"Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_browser_test","text":"SyntheticsBrowserTest update_browser_test(public_id, body) Edit a browser test Edit the configuration of a Synthetic browser test.","title":"update_browser_test"},{"location":"v1/SyntheticsApi/#example_21","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(60), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit a browser test api_response = api_instance.update_browser_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_browser_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_21","text":"Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsBrowserTest New test details to be saved.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_21","text":"SyntheticsBrowserTest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_21","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_21","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_21","text":"Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_private_location","text":"SyntheticsPrivateLocation update_private_location(location_id, body) Edit a private location Edit a Synthetics private location.","title":"update_private_location"},{"location":"v1/SyntheticsApi/#example_22","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to be updated. # example passing only required values which don't have defaults set try: # Edit a private location api_response = api_instance.update_private_location(location_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_22","text":"Name Type Description Notes location_id str The ID of the private location. body SyntheticsPrivateLocation Details of the private location to be updated.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_22","text":"SyntheticsPrivateLocation","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_22","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_22","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_22","text":"Status code Description Response headers 200 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_test_pause_status","text":"bool update_test_pause_status(public_id, body) Pause or start a test Pause or start a Synthetics test by changing the status.","title":"update_test_pause_status"},{"location":"v1/SyntheticsApi/#example_23","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the Synthetic test to update. body = SyntheticsUpdateTestPauseStatusPayload( new_status=SyntheticsTestPauseStatus(\"live\"), ) # SyntheticsUpdateTestPauseStatusPayload | Status to set the given Synthetic test to. # example passing only required values which don't have defaults set try: # Pause or start a test api_response = api_instance.update_test_pause_status(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_test_pause_status: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_23","text":"Name Type Description Notes public_id str The public ID of the Synthetic test to update. body SyntheticsUpdateTestPauseStatusPayload Status to set the given Synthetic test to.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_23","text":"bool","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_23","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_23","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_23","text":"Status code Description Response headers 200 OK - Returns a boolean indicating if the update was successful. - 400 JSON format is wrong. - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsAssertion/","text":"SyntheticsAssertion Object describing the assertions type, their associated operator, which property they apply, and upon which target. Properties Name Type Description Notes _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] operator SyntheticsAssertionJSONPathOperator [optional] type SyntheticsAssertionType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertion"},{"location":"v1/SyntheticsAssertion/#syntheticsassertion","text":"Object describing the assertions type, their associated operator, which property they apply, and upon which target.","title":"SyntheticsAssertion"},{"location":"v1/SyntheticsAssertion/#properties","text":"Name Type Description Notes _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] operator SyntheticsAssertionJSONPathOperator [optional] type SyntheticsAssertionType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionJSONPathOperator/","text":"SyntheticsAssertionJSONPathOperator Assertion operator to apply. Properties Name Type Description Notes value str Assertion operator to apply. defaults to \"validatesJSONPath\", must be one of [\"validatesJSONPath\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionJSONPathOperator"},{"location":"v1/SyntheticsAssertionJSONPathOperator/#syntheticsassertionjsonpathoperator","text":"Assertion operator to apply.","title":"SyntheticsAssertionJSONPathOperator"},{"location":"v1/SyntheticsAssertionJSONPathOperator/#properties","text":"Name Type Description Notes value str Assertion operator to apply. defaults to \"validatesJSONPath\", must be one of [\"validatesJSONPath\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionJSONPathTarget/","text":"SyntheticsAssertionJSONPathTarget An assertion for the validatesJSONPath operator. Properties Name Type Description Notes operator SyntheticsAssertionJSONPathOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionJSONPathTarget"},{"location":"v1/SyntheticsAssertionJSONPathTarget/#syntheticsassertionjsonpathtarget","text":"An assertion for the validatesJSONPath operator.","title":"SyntheticsAssertionJSONPathTarget"},{"location":"v1/SyntheticsAssertionJSONPathTarget/#properties","text":"Name Type Description Notes operator SyntheticsAssertionJSONPathOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionJSONPathTargetTarget/","text":"SyntheticsAssertionJSONPathTargetTarget Composed target for validatesJSONPath operator. Properties Name Type Description Notes json_path str The JSON path to assert. [optional] operator str The specific operator to use on the path. [optional] target_value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The path target value to compare to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionJSONPathTargetTarget"},{"location":"v1/SyntheticsAssertionJSONPathTargetTarget/#syntheticsassertionjsonpathtargettarget","text":"Composed target for validatesJSONPath operator.","title":"SyntheticsAssertionJSONPathTargetTarget"},{"location":"v1/SyntheticsAssertionJSONPathTargetTarget/#properties","text":"Name Type Description Notes json_path str The JSON path to assert. [optional] operator str The specific operator to use on the path. [optional] target_value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The path target value to compare to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionOperator/","text":"SyntheticsAssertionOperator Assertion operator to apply. Properties Name Type Description Notes value str Assertion operator to apply. must be one of [\"contains\", \"doesNotContain\", \"is\", \"isNot\", \"lessThan\", \"lessThanOrEqual\", \"moreThan\", \"moreThanOrEqual\", \"matches\", \"doesNotMatch\", \"validates\", \"isInMoreThan\", \"isInLessThan\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionOperator"},{"location":"v1/SyntheticsAssertionOperator/#syntheticsassertionoperator","text":"Assertion operator to apply.","title":"SyntheticsAssertionOperator"},{"location":"v1/SyntheticsAssertionOperator/#properties","text":"Name Type Description Notes value str Assertion operator to apply. must be one of [\"contains\", \"doesNotContain\", \"is\", \"isNot\", \"lessThan\", \"lessThanOrEqual\", \"moreThan\", \"moreThanOrEqual\", \"matches\", \"doesNotMatch\", \"validates\", \"isInMoreThan\", \"isInLessThan\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionTarget/","text":"SyntheticsAssertionTarget An assertion which uses a simple target. Properties Name Type Description Notes operator SyntheticsAssertionOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target bool, date, datetime, dict, float, int, list, str Value used by the operator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionTarget"},{"location":"v1/SyntheticsAssertionTarget/#syntheticsassertiontarget","text":"An assertion which uses a simple target.","title":"SyntheticsAssertionTarget"},{"location":"v1/SyntheticsAssertionTarget/#properties","text":"Name Type Description Notes operator SyntheticsAssertionOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target bool, date, datetime, dict, float, int, list, str Value used by the operator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionType/","text":"SyntheticsAssertionType Type of the assertion. Properties Name Type Description Notes value str Type of the assertion. must be one of [\"body\", \"header\", \"statusCode\", \"certificate\", \"responseTime\", \"property\", \"recordEvery\", \"recordSome\", \"tlsVersion\", \"minTlsVersion\", \"latency\", \"packetLossPercentage\", \"packetsReceived\", \"networkHop\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionType"},{"location":"v1/SyntheticsAssertionType/#syntheticsassertiontype","text":"Type of the assertion.","title":"SyntheticsAssertionType"},{"location":"v1/SyntheticsAssertionType/#properties","text":"Name Type Description Notes value str Type of the assertion. must be one of [\"body\", \"header\", \"statusCode\", \"certificate\", \"responseTime\", \"property\", \"recordEvery\", \"recordSome\", \"tlsVersion\", \"minTlsVersion\", \"latency\", \"packetLossPercentage\", \"packetsReceived\", \"networkHop\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBasicAuth/","text":"SyntheticsBasicAuth Object to handle basic authentication when performing the test. Properties Name Type Description Notes password str Password to use for the basic authentication. username str Username to use for the basic authentication. [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBasicAuth"},{"location":"v1/SyntheticsBasicAuth/#syntheticsbasicauth","text":"Object to handle basic authentication when performing the test.","title":"SyntheticsBasicAuth"},{"location":"v1/SyntheticsBasicAuth/#properties","text":"Name Type Description Notes password str Password to use for the basic authentication. username str Username to use for the basic authentication. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserError/","text":"SyntheticsBrowserError Error response object for a browser test. Properties Name Type Description Notes description str Description of the error. name str Name of the error. type SyntheticsBrowserErrorType status_code int Status Code of the error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserError"},{"location":"v1/SyntheticsBrowserError/#syntheticsbrowsererror","text":"Error response object for a browser test.","title":"SyntheticsBrowserError"},{"location":"v1/SyntheticsBrowserError/#properties","text":"Name Type Description Notes description str Description of the error. name str Name of the error. type SyntheticsBrowserErrorType status_code int Status Code of the error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserErrorType/","text":"SyntheticsBrowserErrorType Error type returned by a browser test. Properties Name Type Description Notes value str Error type returned by a browser test. must be one of [\"network\", \"js\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserErrorType"},{"location":"v1/SyntheticsBrowserErrorType/#syntheticsbrowsererrortype","text":"Error type returned by a browser test.","title":"SyntheticsBrowserErrorType"},{"location":"v1/SyntheticsBrowserErrorType/#properties","text":"Name Type Description Notes value str Error type returned by a browser test. must be one of [\"network\", \"js\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTest/","text":"SyntheticsBrowserTest Object containing details about a Synthetic browser test. Properties Name Type Description Notes message str Notification message associated with the test. Message can either be text or an empty string. config SyntheticsBrowserTestConfig [optional] locations [str] Array of locations used to run the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID of the test. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] The steps of the test. [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsBrowserTestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTest"},{"location":"v1/SyntheticsBrowserTest/#syntheticsbrowsertest","text":"Object containing details about a Synthetic browser test.","title":"SyntheticsBrowserTest"},{"location":"v1/SyntheticsBrowserTest/#properties","text":"Name Type Description Notes message str Notification message associated with the test. Message can either be text or an empty string. config SyntheticsBrowserTestConfig [optional] locations [str] Array of locations used to run the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID of the test. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] The steps of the test. [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsBrowserTestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestConfig/","text":"SyntheticsBrowserTestConfig Configuration object for a Synthetic browser test. Properties Name Type Description Notes request SyntheticsTestRequest assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] set_cookie str Cookies to be used for the request, using the Set-Cookie syntax. [optional] variables [SyntheticsBrowserVariable] Array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestConfig"},{"location":"v1/SyntheticsBrowserTestConfig/#syntheticsbrowsertestconfig","text":"Configuration object for a Synthetic browser test.","title":"SyntheticsBrowserTestConfig"},{"location":"v1/SyntheticsBrowserTestConfig/#properties","text":"Name Type Description Notes request SyntheticsTestRequest assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] set_cookie str Cookies to be used for the request, using the Set-Cookie syntax. [optional] variables [SyntheticsBrowserVariable] Array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultData/","text":"SyntheticsBrowserTestResultData Object containing results for your Synthetic browser test. Properties Name Type Description Notes browser_type str Type of browser device used for the browser test. [optional] browser_version str Browser version used for the browser test. [optional] device SyntheticsDevice [optional] duration float Global duration in second of the browser test. [optional] error str Error returned for the browser test. [optional] passed bool Whether or not the browser test was conducted. [optional] received_email_count int The amount of email received during the browser test. [optional] start_url str Starting URL for the browser test. [optional] step_details [SyntheticsStepDetail] Array containing the different browser test steps. [optional] thumbnails_bucket_key bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultData"},{"location":"v1/SyntheticsBrowserTestResultData/#syntheticsbrowsertestresultdata","text":"Object containing results for your Synthetic browser test.","title":"SyntheticsBrowserTestResultData"},{"location":"v1/SyntheticsBrowserTestResultData/#properties","text":"Name Type Description Notes browser_type str Type of browser device used for the browser test. [optional] browser_version str Browser version used for the browser test. [optional] device SyntheticsDevice [optional] duration float Global duration in second of the browser test. [optional] error str Error returned for the browser test. [optional] passed bool Whether or not the browser test was conducted. [optional] received_email_count int The amount of email received during the browser test. [optional] start_url str Starting URL for the browser test. [optional] step_details [SyntheticsStepDetail] Array containing the different browser test steps. [optional] thumbnails_bucket_key bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultFull/","text":"SyntheticsBrowserTestResultFull Object returned describing a browser test result. Properties Name Type Description Notes check SyntheticsBrowserTestResultFullCheck [optional] check_time float When the browser test was conducted. [optional] check_version int Version of the browser test used. [optional] probe_dc str Location from which the browser test was performed. [optional] result SyntheticsBrowserTestResultData [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultFull"},{"location":"v1/SyntheticsBrowserTestResultFull/#syntheticsbrowsertestresultfull","text":"Object returned describing a browser test result.","title":"SyntheticsBrowserTestResultFull"},{"location":"v1/SyntheticsBrowserTestResultFull/#properties","text":"Name Type Description Notes check SyntheticsBrowserTestResultFullCheck [optional] check_time float When the browser test was conducted. [optional] check_version int Version of the browser test used. [optional] probe_dc str Location from which the browser test was performed. [optional] result SyntheticsBrowserTestResultData [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultFullCheck/","text":"SyntheticsBrowserTestResultFullCheck Object describing the browser test configuration. Properties Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultFullCheck"},{"location":"v1/SyntheticsBrowserTestResultFullCheck/#syntheticsbrowsertestresultfullcheck","text":"Object describing the browser test configuration.","title":"SyntheticsBrowserTestResultFullCheck"},{"location":"v1/SyntheticsBrowserTestResultFullCheck/#properties","text":"Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultShort/","text":"SyntheticsBrowserTestResultShort Object with the results of a single Synthetic browser test. Properties Name Type Description Notes check_time float Last time the browser test was performed. [optional] probe_dc str Location from which the Browser test was performed. [optional] result SyntheticsBrowserTestResultShortResult [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultShort"},{"location":"v1/SyntheticsBrowserTestResultShort/#syntheticsbrowsertestresultshort","text":"Object with the results of a single Synthetic browser test.","title":"SyntheticsBrowserTestResultShort"},{"location":"v1/SyntheticsBrowserTestResultShort/#properties","text":"Name Type Description Notes check_time float Last time the browser test was performed. [optional] probe_dc str Location from which the Browser test was performed. [optional] result SyntheticsBrowserTestResultShortResult [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultShortResult/","text":"SyntheticsBrowserTestResultShortResult Object with the result of the last browser test run. Properties Name Type Description Notes device SyntheticsDevice [optional] duration float Length in second of the browser test run. [optional] error_count int Amount of errors collected for a single browser test run. [optional] step_count_completed int Amount of browser test steps completed before failing. [optional] step_count_total int Total amount of browser test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultShortResult"},{"location":"v1/SyntheticsBrowserTestResultShortResult/#syntheticsbrowsertestresultshortresult","text":"Object with the result of the last browser test run.","title":"SyntheticsBrowserTestResultShortResult"},{"location":"v1/SyntheticsBrowserTestResultShortResult/#properties","text":"Name Type Description Notes device SyntheticsDevice [optional] duration float Length in second of the browser test run. [optional] error_count int Amount of errors collected for a single browser test run. [optional] step_count_completed int Amount of browser test steps completed before failing. [optional] step_count_total int Total amount of browser test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestType/","text":"SyntheticsBrowserTestType Type of the Synthetic test, browser . Properties Name Type Description Notes value str Type of the Synthetic test, `browser`. defaults to \"browser\", must be one of [\"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestType"},{"location":"v1/SyntheticsBrowserTestType/#syntheticsbrowsertesttype","text":"Type of the Synthetic test, browser .","title":"SyntheticsBrowserTestType"},{"location":"v1/SyntheticsBrowserTestType/#properties","text":"Name Type Description Notes value str Type of the Synthetic test, `browser`. defaults to \"browser\", must be one of [\"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserVariable/","text":"SyntheticsBrowserVariable Object defining a variable that can be used in your browser test. Learn more in the Browser test Actions documentation . Properties Name Type Description Notes name str Name of the variable. type SyntheticsBrowserVariableType example str Example for the variable. [optional] id str ID for the variable. [optional] pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserVariable"},{"location":"v1/SyntheticsBrowserVariable/#syntheticsbrowservariable","text":"Object defining a variable that can be used in your browser test. Learn more in the Browser test Actions documentation .","title":"SyntheticsBrowserVariable"},{"location":"v1/SyntheticsBrowserVariable/#properties","text":"Name Type Description Notes name str Name of the variable. type SyntheticsBrowserVariableType example str Example for the variable. [optional] id str ID for the variable. [optional] pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserVariableType/","text":"SyntheticsBrowserVariableType Type of browser test variable. Properties Name Type Description Notes value str Type of browser test variable. must be one of [\"element\", \"email\", \"global\", \"javascript\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserVariableType"},{"location":"v1/SyntheticsBrowserVariableType/#syntheticsbrowservariabletype","text":"Type of browser test variable.","title":"SyntheticsBrowserVariableType"},{"location":"v1/SyntheticsBrowserVariableType/#properties","text":"Name Type Description Notes value str Type of browser test variable. must be one of [\"element\", \"email\", \"global\", \"javascript\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITest/","text":"SyntheticsCITest Test configuration for Synthetics CI Properties Name Type Description Notes public_id str The public ID of the Synthetics test to trigger. allow_insecure_certificates bool Disable certificate checks in API tests. [optional] basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] body_type str Type of the data sent in a synthetics API test. [optional] cookies str Cookies for the request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] headers SyntheticsTestHeaders [optional] locations [str] Array of locations used to run the test. [optional] metadata SyntheticsCITestMetadata [optional] retry SyntheticsTestOptionsRetry [optional] start_url str Starting URL for the browser test. [optional] variables {str: (str,)} Variables to replace in the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITest"},{"location":"v1/SyntheticsCITest/#syntheticscitest","text":"Test configuration for Synthetics CI","title":"SyntheticsCITest"},{"location":"v1/SyntheticsCITest/#properties","text":"Name Type Description Notes public_id str The public ID of the Synthetics test to trigger. allow_insecure_certificates bool Disable certificate checks in API tests. [optional] basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] body_type str Type of the data sent in a synthetics API test. [optional] cookies str Cookies for the request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] headers SyntheticsTestHeaders [optional] locations [str] Array of locations used to run the test. [optional] metadata SyntheticsCITestMetadata [optional] retry SyntheticsTestOptionsRetry [optional] start_url str Starting URL for the browser test. [optional] variables {str: (str,)} Variables to replace in the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestBody/","text":"SyntheticsCITestBody Object describing the synthetics tests to trigger. Properties Name Type Description Notes tests [SyntheticsCITest] Individual synthetics test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestBody"},{"location":"v1/SyntheticsCITestBody/#syntheticscitestbody","text":"Object describing the synthetics tests to trigger.","title":"SyntheticsCITestBody"},{"location":"v1/SyntheticsCITestBody/#properties","text":"Name Type Description Notes tests [SyntheticsCITest] Individual synthetics test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestMetadata/","text":"SyntheticsCITestMetadata Metadata for the Synthetics tests run Properties Name Type Description Notes ci SyntheticsCITestMetadataCi [optional] git SyntheticsCITestMetadataGit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestMetadata"},{"location":"v1/SyntheticsCITestMetadata/#syntheticscitestmetadata","text":"Metadata for the Synthetics tests run","title":"SyntheticsCITestMetadata"},{"location":"v1/SyntheticsCITestMetadata/#properties","text":"Name Type Description Notes ci SyntheticsCITestMetadataCi [optional] git SyntheticsCITestMetadataGit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestMetadataCi/","text":"SyntheticsCITestMetadataCi Describe CI provider. Properties Name Type Description Notes pipeline str Name of the pipeline. [optional] provider str Name of the CI provider. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestMetadataCi"},{"location":"v1/SyntheticsCITestMetadataCi/#syntheticscitestmetadataci","text":"Describe CI provider.","title":"SyntheticsCITestMetadataCi"},{"location":"v1/SyntheticsCITestMetadataCi/#properties","text":"Name Type Description Notes pipeline str Name of the pipeline. [optional] provider str Name of the CI provider. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestMetadataGit/","text":"SyntheticsCITestMetadataGit Git information. Properties Name Type Description Notes branch str Branch name. [optional] commit_sha str Commit SHA. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestMetadataGit"},{"location":"v1/SyntheticsCITestMetadataGit/#syntheticscitestmetadatagit","text":"Git information.","title":"SyntheticsCITestMetadataGit"},{"location":"v1/SyntheticsCITestMetadataGit/#properties","text":"Name Type Description Notes branch str Branch name. [optional] commit_sha str Commit SHA. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCheckType/","text":"SyntheticsCheckType Type of assertion to apply in an API test. Properties Name Type Description Notes value str Type of assertion to apply in an API test. must be one of [\"equals\", \"notEquals\", \"contains\", \"notContains\", \"startsWith\", \"notStartsWith\", \"greater\", \"lower\", \"greaterEquals\", \"lowerEquals\", \"matchRegex\", \"between\", \"isEmpty\", \"notIsEmpty\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCheckType"},{"location":"v1/SyntheticsCheckType/#syntheticschecktype","text":"Type of assertion to apply in an API test.","title":"SyntheticsCheckType"},{"location":"v1/SyntheticsCheckType/#properties","text":"Name Type Description Notes value str Type of assertion to apply in an API test. must be one of [\"equals\", \"notEquals\", \"contains\", \"notContains\", \"startsWith\", \"notStartsWith\", \"greater\", \"lower\", \"greaterEquals\", \"lowerEquals\", \"matchRegex\", \"between\", \"isEmpty\", \"notIsEmpty\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsConfigVariable/","text":"SyntheticsConfigVariable Object defining a variable that can be used in your test configuration. Properties Name Type Description Notes example str Example for the variable. name str Name of the variable. type SyntheticsConfigVariableType pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsConfigVariable"},{"location":"v1/SyntheticsConfigVariable/#syntheticsconfigvariable","text":"Object defining a variable that can be used in your test configuration.","title":"SyntheticsConfigVariable"},{"location":"v1/SyntheticsConfigVariable/#properties","text":"Name Type Description Notes example str Example for the variable. name str Name of the variable. type SyntheticsConfigVariableType pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsConfigVariableType/","text":"SyntheticsConfigVariableType Type of the configuration variable. Properties Name Type Description Notes value str Type of the configuration variable. defaults to \"text\", must be one of [\"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsConfigVariableType"},{"location":"v1/SyntheticsConfigVariableType/#syntheticsconfigvariabletype","text":"Type of the configuration variable.","title":"SyntheticsConfigVariableType"},{"location":"v1/SyntheticsConfigVariableType/#properties","text":"Name Type Description Notes value str Type of the configuration variable. defaults to \"text\", must be one of [\"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCoreWebVitals/","text":"SyntheticsCoreWebVitals Core Web Vitals attached to a browser test step. Properties Name Type Description Notes cls int Cumulative Layout Shift. [optional] lcp int Largest Contentful Paint in milliseconds. [optional] url str URL attached to the metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCoreWebVitals"},{"location":"v1/SyntheticsCoreWebVitals/#syntheticscorewebvitals","text":"Core Web Vitals attached to a browser test step.","title":"SyntheticsCoreWebVitals"},{"location":"v1/SyntheticsCoreWebVitals/#properties","text":"Name Type Description Notes cls int Cumulative Layout Shift. [optional] lcp int Largest Contentful Paint in milliseconds. [optional] url str URL attached to the metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeleteTestsPayload/","text":"SyntheticsDeleteTestsPayload A JSON list of the ID or IDs of the Synthetic tests that you want to delete. Properties Name Type Description Notes public_ids [str] An array of Synthetic test IDs you want to delete. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeleteTestsPayload"},{"location":"v1/SyntheticsDeleteTestsPayload/#syntheticsdeletetestspayload","text":"A JSON list of the ID or IDs of the Synthetic tests that you want to delete.","title":"SyntheticsDeleteTestsPayload"},{"location":"v1/SyntheticsDeleteTestsPayload/#properties","text":"Name Type Description Notes public_ids [str] An array of Synthetic test IDs you want to delete. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeleteTestsResponse/","text":"SyntheticsDeleteTestsResponse Response object for deleting Synthetic tests. Properties Name Type Description Notes deleted_tests [SyntheticsDeletedTest] Array of objects containing a deleted Synthetic test ID with the associated deletion timestamp. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeleteTestsResponse"},{"location":"v1/SyntheticsDeleteTestsResponse/#syntheticsdeletetestsresponse","text":"Response object for deleting Synthetic tests.","title":"SyntheticsDeleteTestsResponse"},{"location":"v1/SyntheticsDeleteTestsResponse/#properties","text":"Name Type Description Notes deleted_tests [SyntheticsDeletedTest] Array of objects containing a deleted Synthetic test ID with the associated deletion timestamp. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeletedTest/","text":"SyntheticsDeletedTest Object containing a deleted Synthetic test ID with the associated deletion timestamp. Properties Name Type Description Notes deleted_at datetime Deletion timestamp of the Synthetic test ID. [optional] public_id str The Synthetic test ID deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeletedTest"},{"location":"v1/SyntheticsDeletedTest/#syntheticsdeletedtest","text":"Object containing a deleted Synthetic test ID with the associated deletion timestamp.","title":"SyntheticsDeletedTest"},{"location":"v1/SyntheticsDeletedTest/#properties","text":"Name Type Description Notes deleted_at datetime Deletion timestamp of the Synthetic test ID. [optional] public_id str The Synthetic test ID deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDevice/","text":"SyntheticsDevice Object describing the device used to perform the Synthetic test. Properties Name Type Description Notes height int Screen height of the device. id SyntheticsDeviceID name str The device name. width int Screen width of the device. is_mobile bool Whether or not the device is a mobile. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDevice"},{"location":"v1/SyntheticsDevice/#syntheticsdevice","text":"Object describing the device used to perform the Synthetic test.","title":"SyntheticsDevice"},{"location":"v1/SyntheticsDevice/#properties","text":"Name Type Description Notes height int Screen height of the device. id SyntheticsDeviceID name str The device name. width int Screen width of the device. is_mobile bool Whether or not the device is a mobile. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeviceID/","text":"SyntheticsDeviceID The device ID. Properties Name Type Description Notes value str The device ID. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeviceID"},{"location":"v1/SyntheticsDeviceID/#syntheticsdeviceid","text":"The device ID.","title":"SyntheticsDeviceID"},{"location":"v1/SyntheticsDeviceID/#properties","text":"Name Type Description Notes value str The device ID. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsErrorCode/","text":"SyntheticsErrorCode Error code that can be returned by a Synthetic test. Properties Name Type Description Notes value str Error code that can be returned by a Synthetic test. must be one of [\"NO_ERROR\", \"UNKNOWN\", \"DNS\", \"SSL\", \"TIMEOUT\", \"DENIED\", \"INCORRECT_ASSERTION\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsErrorCode"},{"location":"v1/SyntheticsErrorCode/#syntheticserrorcode","text":"Error code that can be returned by a Synthetic test.","title":"SyntheticsErrorCode"},{"location":"v1/SyntheticsErrorCode/#properties","text":"Name Type Description Notes value str Error code that can be returned by a Synthetic test. must be one of [\"NO_ERROR\", \"UNKNOWN\", \"DNS\", \"SSL\", \"TIMEOUT\", \"DENIED\", \"INCORRECT_ASSERTION\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGetAPITestLatestResultsResponse/","text":"SyntheticsGetAPITestLatestResultsResponse Object with the latest Synthetic API test run. Properties Name Type Description Notes last_timestamp_fetched int Timestamp of the latest API test run. [optional] results [SyntheticsAPITestResultShort] Result of the latest API test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGetAPITestLatestResultsResponse"},{"location":"v1/SyntheticsGetAPITestLatestResultsResponse/#syntheticsgetapitestlatestresultsresponse","text":"Object with the latest Synthetic API test run.","title":"SyntheticsGetAPITestLatestResultsResponse"},{"location":"v1/SyntheticsGetAPITestLatestResultsResponse/#properties","text":"Name Type Description Notes last_timestamp_fetched int Timestamp of the latest API test run. [optional] results [SyntheticsAPITestResultShort] Result of the latest API test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGetBrowserTestLatestResultsResponse/","text":"SyntheticsGetBrowserTestLatestResultsResponse Object with the latest Synthetic browser test run. Properties Name Type Description Notes last_timestamp_fetched int Timestamp of the latest browser test run. [optional] results [SyntheticsBrowserTestResultShort] Result of the latest browser test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGetBrowserTestLatestResultsResponse"},{"location":"v1/SyntheticsGetBrowserTestLatestResultsResponse/#syntheticsgetbrowsertestlatestresultsresponse","text":"Object with the latest Synthetic browser test run.","title":"SyntheticsGetBrowserTestLatestResultsResponse"},{"location":"v1/SyntheticsGetBrowserTestLatestResultsResponse/#properties","text":"Name Type Description Notes last_timestamp_fetched int Timestamp of the latest browser test run. [optional] results [SyntheticsBrowserTestResultShort] Result of the latest browser test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariable/","text":"SyntheticsGlobalVariable Synthetics global variable. Properties Name Type Description Notes description str Description of the global variable. name str Name of the global variable. tags [str] Tags of the global variable. value SyntheticsGlobalVariableValue id str Unique identifier of the global variable. optional parse_test_options SyntheticsGlobalVariableParseTestOptions [optional] parse_test_public_id str A Synthetic test ID to use as a test to generate the variable value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariable"},{"location":"v1/SyntheticsGlobalVariable/#syntheticsglobalvariable","text":"Synthetics global variable.","title":"SyntheticsGlobalVariable"},{"location":"v1/SyntheticsGlobalVariable/#properties","text":"Name Type Description Notes description str Description of the global variable. name str Name of the global variable. tags [str] Tags of the global variable. value SyntheticsGlobalVariableValue id str Unique identifier of the global variable. optional parse_test_options SyntheticsGlobalVariableParseTestOptions [optional] parse_test_public_id str A Synthetic test ID to use as a test to generate the variable value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableParseTestOptions/","text":"SyntheticsGlobalVariableParseTestOptions Parser options to use for retrieving a Synthetics global variable from a Synthetics Test. Used in conjunction with parse_test_public_id . Properties Name Type Description Notes parser SyntheticsVariableParser type SyntheticsGlobalVariableParseTestOptionsType field str When type is `http_header`, name of the header to use to extract the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableParseTestOptions"},{"location":"v1/SyntheticsGlobalVariableParseTestOptions/#syntheticsglobalvariableparsetestoptions","text":"Parser options to use for retrieving a Synthetics global variable from a Synthetics Test. Used in conjunction with parse_test_public_id .","title":"SyntheticsGlobalVariableParseTestOptions"},{"location":"v1/SyntheticsGlobalVariableParseTestOptions/#properties","text":"Name Type Description Notes parser SyntheticsVariableParser type SyntheticsGlobalVariableParseTestOptionsType field str When type is `http_header`, name of the header to use to extract the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableParseTestOptionsType/","text":"SyntheticsGlobalVariableParseTestOptionsType Property of the Synthetics Test Response to use for a Synthetics global variable. Properties Name Type Description Notes value str Property of the Synthetics Test Response to use for a Synthetics global variable. must be one of [\"http_body\", \"http_header\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableParseTestOptionsType"},{"location":"v1/SyntheticsGlobalVariableParseTestOptionsType/#syntheticsglobalvariableparsetestoptionstype","text":"Property of the Synthetics Test Response to use for a Synthetics global variable.","title":"SyntheticsGlobalVariableParseTestOptionsType"},{"location":"v1/SyntheticsGlobalVariableParseTestOptionsType/#properties","text":"Name Type Description Notes value str Property of the Synthetics Test Response to use for a Synthetics global variable. must be one of [\"http_body\", \"http_header\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableParserType/","text":"SyntheticsGlobalVariableParserType Type of parser for a Synthetics global variable from a synthetics test. Properties Name Type Description Notes value str Type of parser for a Synthetics global variable from a synthetics test. must be one of [\"raw\", \"json_path\", \"regex\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableParserType"},{"location":"v1/SyntheticsGlobalVariableParserType/#syntheticsglobalvariableparsertype","text":"Type of parser for a Synthetics global variable from a synthetics test.","title":"SyntheticsGlobalVariableParserType"},{"location":"v1/SyntheticsGlobalVariableParserType/#properties","text":"Name Type Description Notes value str Type of parser for a Synthetics global variable from a synthetics test. must be one of [\"raw\", \"json_path\", \"regex\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableValue/","text":"SyntheticsGlobalVariableValue Value of the global variable. Properties Name Type Description Notes value str Value of the global variable. When reading a global variable, the value will not be present if the variable is secure. secure bool Determines if the variable is secure. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableValue"},{"location":"v1/SyntheticsGlobalVariableValue/#syntheticsglobalvariablevalue","text":"Value of the global variable.","title":"SyntheticsGlobalVariableValue"},{"location":"v1/SyntheticsGlobalVariableValue/#properties","text":"Name Type Description Notes value str Value of the global variable. When reading a global variable, the value will not be present if the variable is secure. secure bool Determines if the variable is secure. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsListTestsResponse/","text":"SyntheticsListTestsResponse Object containing an array of Synthetic tests configuration. Properties Name Type Description Notes tests [SyntheticsTestDetails] Array of Synthetic tests configuration. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsListTestsResponse"},{"location":"v1/SyntheticsListTestsResponse/#syntheticslisttestsresponse","text":"Object containing an array of Synthetic tests configuration.","title":"SyntheticsListTestsResponse"},{"location":"v1/SyntheticsListTestsResponse/#properties","text":"Name Type Description Notes tests [SyntheticsTestDetails] Array of Synthetic tests configuration. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsLocation/","text":"SyntheticsLocation Synthetic location that can be used when creating or editing a test. Properties Name Type Description Notes id str Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsLocation"},{"location":"v1/SyntheticsLocation/#syntheticslocation","text":"Synthetic location that can be used when creating or editing a test.","title":"SyntheticsLocation"},{"location":"v1/SyntheticsLocation/#properties","text":"Name Type Description Notes id str Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsLocations/","text":"SyntheticsLocations List of Synthetics locations. Properties Name Type Description Notes locations [SyntheticsLocation] List of Synthetics locations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsLocations"},{"location":"v1/SyntheticsLocations/#syntheticslocations","text":"List of Synthetics locations.","title":"SyntheticsLocations"},{"location":"v1/SyntheticsLocations/#properties","text":"Name Type Description Notes locations [SyntheticsLocation] List of Synthetics locations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsParsingOptions/","text":"SyntheticsParsingOptions Parsing options for variables to extract. Properties Name Type Description Notes field str When type is `http_header`, name of the header to use to extract the value. [optional] name str Name of the variable to extract. [optional] parser SyntheticsVariableParser [optional] type SyntheticsGlobalVariableParseTestOptionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsParsingOptions"},{"location":"v1/SyntheticsParsingOptions/#syntheticsparsingoptions","text":"Parsing options for variables to extract.","title":"SyntheticsParsingOptions"},{"location":"v1/SyntheticsParsingOptions/#properties","text":"Name Type Description Notes field str When type is `http_header`, name of the header to use to extract the value. [optional] name str Name of the variable to extract. [optional] parser SyntheticsVariableParser [optional] type SyntheticsGlobalVariableParseTestOptionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPlayingTab/","text":"SyntheticsPlayingTab Navigate between different tabs for your browser test. Properties Name Type Description Notes value int Navigate between different tabs for your browser test. must be one of [-1, 0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPlayingTab"},{"location":"v1/SyntheticsPlayingTab/#syntheticsplayingtab","text":"Navigate between different tabs for your browser test.","title":"SyntheticsPlayingTab"},{"location":"v1/SyntheticsPlayingTab/#properties","text":"Name Type Description Notes value int Navigate between different tabs for your browser test. must be one of [-1, 0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocation/","text":"SyntheticsPrivateLocation Object containing information about the private location to create. Properties Name Type Description Notes description str Description of the private location. name str Name of the private location. tags [str] Array of tags attached to the private location. id str Unique identifier of the private location. optional secrets SyntheticsPrivateLocationSecrets [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocation"},{"location":"v1/SyntheticsPrivateLocation/#syntheticsprivatelocation","text":"Object containing information about the private location to create.","title":"SyntheticsPrivateLocation"},{"location":"v1/SyntheticsPrivateLocation/#properties","text":"Name Type Description Notes description str Description of the private location. name str Name of the private location. tags [str] Array of tags attached to the private location. id str Unique identifier of the private location. optional secrets SyntheticsPrivateLocationSecrets [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationCreationResponse/","text":"SyntheticsPrivateLocationCreationResponse Object that contains the new private location, the public key for result encryption, and the configuration skeleton. Properties Name Type Description Notes config {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. [optional] private_location SyntheticsPrivateLocation [optional] result_encryption SyntheticsPrivateLocationCreationResponseResultEncryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationCreationResponse"},{"location":"v1/SyntheticsPrivateLocationCreationResponse/#syntheticsprivatelocationcreationresponse","text":"Object that contains the new private location, the public key for result encryption, and the configuration skeleton.","title":"SyntheticsPrivateLocationCreationResponse"},{"location":"v1/SyntheticsPrivateLocationCreationResponse/#properties","text":"Name Type Description Notes config {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. [optional] private_location SyntheticsPrivateLocation [optional] result_encryption SyntheticsPrivateLocationCreationResponseResultEncryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationCreationResponseResultEncryption/","text":"SyntheticsPrivateLocationCreationResponseResultEncryption Public key for the result encryption. Properties Name Type Description Notes id str Fingerprint for the encryption key. [optional] key str Public key for result encryption. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationCreationResponseResultEncryption"},{"location":"v1/SyntheticsPrivateLocationCreationResponseResultEncryption/#syntheticsprivatelocationcreationresponseresultencryption","text":"Public key for the result encryption.","title":"SyntheticsPrivateLocationCreationResponseResultEncryption"},{"location":"v1/SyntheticsPrivateLocationCreationResponseResultEncryption/#properties","text":"Name Type Description Notes id str Fingerprint for the encryption key. [optional] key str Public key for result encryption. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationSecrets/","text":"SyntheticsPrivateLocationSecrets Secrets for the private location. Only present in the response when creating the private location. Properties Name Type Description Notes authentication SyntheticsPrivateLocationSecretsAuthentication [optional] config_decryption SyntheticsPrivateLocationSecretsConfigDecryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationSecrets"},{"location":"v1/SyntheticsPrivateLocationSecrets/#syntheticsprivatelocationsecrets","text":"Secrets for the private location. Only present in the response when creating the private location.","title":"SyntheticsPrivateLocationSecrets"},{"location":"v1/SyntheticsPrivateLocationSecrets/#properties","text":"Name Type Description Notes authentication SyntheticsPrivateLocationSecretsAuthentication [optional] config_decryption SyntheticsPrivateLocationSecretsConfigDecryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationSecretsAuthentication/","text":"SyntheticsPrivateLocationSecretsAuthentication Authentication part of the secrets. Properties Name Type Description Notes id str Access key for the private location. optional key str Secret access key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationSecretsAuthentication"},{"location":"v1/SyntheticsPrivateLocationSecretsAuthentication/#syntheticsprivatelocationsecretsauthentication","text":"Authentication part of the secrets.","title":"SyntheticsPrivateLocationSecretsAuthentication"},{"location":"v1/SyntheticsPrivateLocationSecretsAuthentication/#properties","text":"Name Type Description Notes id str Access key for the private location. optional key str Secret access key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationSecretsConfigDecryption/","text":"SyntheticsPrivateLocationSecretsConfigDecryption Private key for the private location. Properties Name Type Description Notes key str Private key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationSecretsConfigDecryption"},{"location":"v1/SyntheticsPrivateLocationSecretsConfigDecryption/#syntheticsprivatelocationsecretsconfigdecryption","text":"Private key for the private location.","title":"SyntheticsPrivateLocationSecretsConfigDecryption"},{"location":"v1/SyntheticsPrivateLocationSecretsConfigDecryption/#properties","text":"Name Type Description Notes key str Private key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsSSLCertificate/","text":"SyntheticsSSLCertificate Object describing the SSL certificate used for a Synthetic test. Properties Name Type Description Notes cipher str Cipher used for the connection. [optional] exponent float Exponent associated to the certificate. [optional] ext_key_usage [str] Array of extensions and details used for the certificate. [optional] fingerprint str MD5 digest of the DER-encoded Certificate information. [optional] fingerprint256 str SHA-1 digest of the DER-encoded Certificate information. [optional] issuer SyntheticsSSLCertificateIssuer [optional] modulus str Modulus associated to the SSL certificate private key. [optional] protocol str TLS protocol used for the test. [optional] serial_number str Serial Number assigned by Symantec to the SSL certificate. [optional] subject SyntheticsSSLCertificateSubject [optional] valid_from datetime Date from which the SSL certificate is valid. [optional] valid_to datetime Date until which the SSL certificate is valid. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsSSLCertificate"},{"location":"v1/SyntheticsSSLCertificate/#syntheticssslcertificate","text":"Object describing the SSL certificate used for a Synthetic test.","title":"SyntheticsSSLCertificate"},{"location":"v1/SyntheticsSSLCertificate/#properties","text":"Name Type Description Notes cipher str Cipher used for the connection. [optional] exponent float Exponent associated to the certificate. [optional] ext_key_usage [str] Array of extensions and details used for the certificate. [optional] fingerprint str MD5 digest of the DER-encoded Certificate information. [optional] fingerprint256 str SHA-1 digest of the DER-encoded Certificate information. [optional] issuer SyntheticsSSLCertificateIssuer [optional] modulus str Modulus associated to the SSL certificate private key. [optional] protocol str TLS protocol used for the test. [optional] serial_number str Serial Number assigned by Symantec to the SSL certificate. [optional] subject SyntheticsSSLCertificateSubject [optional] valid_from datetime Date from which the SSL certificate is valid. [optional] valid_to datetime Date until which the SSL certificate is valid. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsSSLCertificateIssuer/","text":"SyntheticsSSLCertificateIssuer Object describing the issuer of a SSL certificate. Properties Name Type Description Notes c str Country Name that issued the certificate. [optional] cn str Common Name that issued certificate. [optional] l str Locality that issued the certificate. [optional] o str Organization that issued the certificate. [optional] ou str Organizational Unit that issued the certificate. [optional] st str State Or Province Name that issued the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsSSLCertificateIssuer"},{"location":"v1/SyntheticsSSLCertificateIssuer/#syntheticssslcertificateissuer","text":"Object describing the issuer of a SSL certificate.","title":"SyntheticsSSLCertificateIssuer"},{"location":"v1/SyntheticsSSLCertificateIssuer/#properties","text":"Name Type Description Notes c str Country Name that issued the certificate. [optional] cn str Common Name that issued certificate. [optional] l str Locality that issued the certificate. [optional] o str Organization that issued the certificate. [optional] ou str Organizational Unit that issued the certificate. [optional] st str State Or Province Name that issued the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsSSLCertificateSubject/","text":"SyntheticsSSLCertificateSubject Object describing the SSL certificate used for the test. Properties Name Type Description Notes c str Country Name associated with the certificate. [optional] cn str Common Name that associated with the certificate. [optional] l str Locality associated with the certificate. [optional] o str Organization associated with the certificate. [optional] ou str Organizational Unit associated with the certificate. [optional] st str State Or Province Name associated with the certificate. [optional] alt_name str Subject Alternative Name associated with the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsSSLCertificateSubject"},{"location":"v1/SyntheticsSSLCertificateSubject/#syntheticssslcertificatesubject","text":"Object describing the SSL certificate used for the test.","title":"SyntheticsSSLCertificateSubject"},{"location":"v1/SyntheticsSSLCertificateSubject/#properties","text":"Name Type Description Notes c str Country Name associated with the certificate. [optional] cn str Common Name that associated with the certificate. [optional] l str Locality associated with the certificate. [optional] o str Organization associated with the certificate. [optional] ou str Organizational Unit associated with the certificate. [optional] st str State Or Province Name associated with the certificate. [optional] alt_name str Subject Alternative Name associated with the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStep/","text":"SyntheticsStep The steps used in a Synthetics browser test. Properties Name Type Description Notes allow_failure bool A boolean set to allow this step to fail. [optional] name str The name of the step. [optional] params {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The parameters of the step. [optional] timeout int The time before declaring a step failed. [optional] type SyntheticsStepType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStep"},{"location":"v1/SyntheticsStep/#syntheticsstep","text":"The steps used in a Synthetics browser test.","title":"SyntheticsStep"},{"location":"v1/SyntheticsStep/#properties","text":"Name Type Description Notes allow_failure bool A boolean set to allow this step to fail. [optional] name str The name of the step. [optional] params {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The parameters of the step. [optional] timeout int The time before declaring a step failed. [optional] type SyntheticsStepType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStepDetail/","text":"SyntheticsStepDetail Object describing a step for a Synthetic test. Properties Name Type Description Notes browser_errors [SyntheticsBrowserError] Array of errors collected for a browser test. [optional] check_type SyntheticsCheckType [optional] description str Description of the test. [optional] duration float Total duration in millisecond of the test. [optional] error str Error returned by the test. [optional] playing_tab SyntheticsPlayingTab [optional] screenshot_bucket_key bool Whether or not screenshots where collected by the test. [optional] skipped bool Whether or not to skip this step. [optional] snapshot_bucket_key bool Whether or not snapshots where collected by the test. [optional] step_id int The step ID. [optional] sub_test_step_details [SyntheticsStepDetail] If this steps include a sub-test. Subtests documentation . [optional] time_to_interactive float Time before starting the step. [optional] type SyntheticsStepType [optional] url str URL to perform the step against. [optional] value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Value for the step. [optional] vitals_metrics [SyntheticsCoreWebVitals] Array of Core Web Vitals metrics for the step. [optional] warnings [SyntheticsStepDetailWarning] Warning collected that didn't failed the step. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStepDetail"},{"location":"v1/SyntheticsStepDetail/#syntheticsstepdetail","text":"Object describing a step for a Synthetic test.","title":"SyntheticsStepDetail"},{"location":"v1/SyntheticsStepDetail/#properties","text":"Name Type Description Notes browser_errors [SyntheticsBrowserError] Array of errors collected for a browser test. [optional] check_type SyntheticsCheckType [optional] description str Description of the test. [optional] duration float Total duration in millisecond of the test. [optional] error str Error returned by the test. [optional] playing_tab SyntheticsPlayingTab [optional] screenshot_bucket_key bool Whether or not screenshots where collected by the test. [optional] skipped bool Whether or not to skip this step. [optional] snapshot_bucket_key bool Whether or not snapshots where collected by the test. [optional] step_id int The step ID. [optional] sub_test_step_details [SyntheticsStepDetail] If this steps include a sub-test. Subtests documentation . [optional] time_to_interactive float Time before starting the step. [optional] type SyntheticsStepType [optional] url str URL to perform the step against. [optional] value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Value for the step. [optional] vitals_metrics [SyntheticsCoreWebVitals] Array of Core Web Vitals metrics for the step. [optional] warnings [SyntheticsStepDetailWarning] Warning collected that didn't failed the step. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStepDetailWarning/","text":"SyntheticsStepDetailWarning Object collecting warnings for a given step. Properties Name Type Description Notes message str Message for the warning. type SyntheticsWarningType [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStepDetailWarning"},{"location":"v1/SyntheticsStepDetailWarning/#syntheticsstepdetailwarning","text":"Object collecting warnings for a given step.","title":"SyntheticsStepDetailWarning"},{"location":"v1/SyntheticsStepDetailWarning/#properties","text":"Name Type Description Notes message str Message for the warning. type SyntheticsWarningType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStepType/","text":"SyntheticsStepType Step type used in your Synthetic test. Properties Name Type Description Notes value str Step type used in your Synthetic test. must be one of [\"assertCurrentUrl\", \"assertElementAttribute\", \"assertElementContent\", \"assertElementPresent\", \"assertEmail\", \"assertFileDownload\", \"assertFromJavascript\", \"assertPageContains\", \"assertPageLacks\", \"click\", \"extractFromJavascript\", \"extractVariable\", \"goToEmailLink\", \"goToUrl\", \"goToUrlAndMeasureTti\", \"hover\", \"playSubTest\", \"pressKey\", \"refresh\", \"runApiTest\", \"scroll\", \"selectOption\", \"typeText\", \"uploadFiles\", \"wait\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStepType"},{"location":"v1/SyntheticsStepType/#syntheticssteptype","text":"Step type used in your Synthetic test.","title":"SyntheticsStepType"},{"location":"v1/SyntheticsStepType/#properties","text":"Name Type Description Notes value str Step type used in your Synthetic test. must be one of [\"assertCurrentUrl\", \"assertElementAttribute\", \"assertElementContent\", \"assertElementPresent\", \"assertEmail\", \"assertFileDownload\", \"assertFromJavascript\", \"assertPageContains\", \"assertPageLacks\", \"click\", \"extractFromJavascript\", \"extractVariable\", \"goToEmailLink\", \"goToUrl\", \"goToUrlAndMeasureTti\", \"hover\", \"playSubTest\", \"pressKey\", \"refresh\", \"runApiTest\", \"scroll\", \"selectOption\", \"typeText\", \"uploadFiles\", \"wait\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestConfig/","text":"SyntheticsTestConfig Configuration object for a Synthetic test. Properties Name Type Description Notes request SyntheticsTestRequest assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional] variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestConfig"},{"location":"v1/SyntheticsTestConfig/#syntheticstestconfig","text":"Configuration object for a Synthetic test.","title":"SyntheticsTestConfig"},{"location":"v1/SyntheticsTestConfig/#properties","text":"Name Type Description Notes request SyntheticsTestRequest assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional] variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestDetails/","text":"SyntheticsTestDetails Object containing details about your Synthetic test. Properties Name Type Description Notes config SyntheticsTestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The test public ID. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] For browser test, the steps of the test. [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsTestDetailsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestDetails"},{"location":"v1/SyntheticsTestDetails/#syntheticstestdetails","text":"Object containing details about your Synthetic test.","title":"SyntheticsTestDetails"},{"location":"v1/SyntheticsTestDetails/#properties","text":"Name Type Description Notes config SyntheticsTestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The test public ID. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] For browser test, the steps of the test. [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsTestDetailsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestDetailsSubType/","text":"SyntheticsTestDetailsSubType The subtype of the Synthetic API test, http , ssl , tcp , dns , icmp or multi . Properties Name Type Description Notes value str The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns`, `icmp` or `multi`. must be one of [\"http\", \"ssl\", \"tcp\", \"dns\", \"multi\", \"icmp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestDetailsSubType"},{"location":"v1/SyntheticsTestDetailsSubType/#syntheticstestdetailssubtype","text":"The subtype of the Synthetic API test, http , ssl , tcp , dns , icmp or multi .","title":"SyntheticsTestDetailsSubType"},{"location":"v1/SyntheticsTestDetailsSubType/#properties","text":"Name Type Description Notes value str The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns`, `icmp` or `multi`. must be one of [\"http\", \"ssl\", \"tcp\", \"dns\", \"multi\", \"icmp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestDetailsType/","text":"SyntheticsTestDetailsType Type of the Synthetic test, either api or browser . Properties Name Type Description Notes value str Type of the Synthetic test, either `api` or `browser`. must be one of [\"api\", \"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestDetailsType"},{"location":"v1/SyntheticsTestDetailsType/#syntheticstestdetailstype","text":"Type of the Synthetic test, either api or browser .","title":"SyntheticsTestDetailsType"},{"location":"v1/SyntheticsTestDetailsType/#properties","text":"Name Type Description Notes value str Type of the Synthetic test, either `api` or `browser`. must be one of [\"api\", \"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestHeaders/","text":"SyntheticsTestHeaders Headers to include when performing the test. Properties Name Type Description Notes any string name str any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestHeaders"},{"location":"v1/SyntheticsTestHeaders/#syntheticstestheaders","text":"Headers to include when performing the test.","title":"SyntheticsTestHeaders"},{"location":"v1/SyntheticsTestHeaders/#properties","text":"Name Type Description Notes any string name str any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestMonitorStatus/","text":"SyntheticsTestMonitorStatus The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data Properties Name Type Description Notes value int The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data must be one of [0, 1, 2, ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestMonitorStatus"},{"location":"v1/SyntheticsTestMonitorStatus/#syntheticstestmonitorstatus","text":"The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data","title":"SyntheticsTestMonitorStatus"},{"location":"v1/SyntheticsTestMonitorStatus/#properties","text":"Name Type Description Notes value int The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data must be one of [0, 1, 2, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestOptions/","text":"SyntheticsTestOptions Object describing the extra options for a Synthetic test. Properties Name Type Description Notes accept_self_signed bool For SSL test, whether or not the test should allow self signed certificates. [optional] allow_insecure bool Allows loading insecure content for an HTTP request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] disable_cors bool Whether or not to disable CORS mechanism. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] min_failure_duration int Minimum amount of time in failure required to trigger an alert. [optional] min_location_failed int Minimum number of locations in failure required to trigger an alert. [optional] monitor_options SyntheticsTestOptionsMonitorOptions [optional] no_screenshot bool Prevents saving screenshots of the steps. [optional] retry SyntheticsTestOptionsRetry [optional] tick_every SyntheticsTickInterval [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestOptions"},{"location":"v1/SyntheticsTestOptions/#syntheticstestoptions","text":"Object describing the extra options for a Synthetic test.","title":"SyntheticsTestOptions"},{"location":"v1/SyntheticsTestOptions/#properties","text":"Name Type Description Notes accept_self_signed bool For SSL test, whether or not the test should allow self signed certificates. [optional] allow_insecure bool Allows loading insecure content for an HTTP request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] disable_cors bool Whether or not to disable CORS mechanism. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] min_failure_duration int Minimum amount of time in failure required to trigger an alert. [optional] min_location_failed int Minimum number of locations in failure required to trigger an alert. [optional] monitor_options SyntheticsTestOptionsMonitorOptions [optional] no_screenshot bool Prevents saving screenshots of the steps. [optional] retry SyntheticsTestOptionsRetry [optional] tick_every SyntheticsTickInterval [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestOptionsMonitorOptions/","text":"SyntheticsTestOptionsMonitorOptions Object containing the options for a Synthetic test as a monitor (for example, renotification). Properties Name Type Description Notes renotify_interval int Time interval before renotifying if the test is still failing (in minutes). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestOptionsMonitorOptions"},{"location":"v1/SyntheticsTestOptionsMonitorOptions/#syntheticstestoptionsmonitoroptions","text":"Object containing the options for a Synthetic test as a monitor (for example, renotification).","title":"SyntheticsTestOptionsMonitorOptions"},{"location":"v1/SyntheticsTestOptionsMonitorOptions/#properties","text":"Name Type Description Notes renotify_interval int Time interval before renotifying if the test is still failing (in minutes). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestOptionsRetry/","text":"SyntheticsTestOptionsRetry Object describing the retry strategy to apply to a Synthetic test. Properties Name Type Description Notes count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestOptionsRetry"},{"location":"v1/SyntheticsTestOptionsRetry/#syntheticstestoptionsretry","text":"Object describing the retry strategy to apply to a Synthetic test.","title":"SyntheticsTestOptionsRetry"},{"location":"v1/SyntheticsTestOptionsRetry/#properties","text":"Name Type Description Notes count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestPauseStatus/","text":"SyntheticsTestPauseStatus Define whether you want to start ( live ) or pause ( paused ) a Synthetic test. Properties Name Type Description Notes value str Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. must be one of [\"live\", \"paused\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestPauseStatus"},{"location":"v1/SyntheticsTestPauseStatus/#syntheticstestpausestatus","text":"Define whether you want to start ( live ) or pause ( paused ) a Synthetic test.","title":"SyntheticsTestPauseStatus"},{"location":"v1/SyntheticsTestPauseStatus/#properties","text":"Name Type Description Notes value str Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. must be one of [\"live\", \"paused\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestProcessStatus/","text":"SyntheticsTestProcessStatus Status of a Synthetic test. Properties Name Type Description Notes value str Status of a Synthetic test. must be one of [\"not_scheduled\", \"scheduled\", \"started\", \"finished\", \"finished_with_error\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestProcessStatus"},{"location":"v1/SyntheticsTestProcessStatus/#syntheticstestprocessstatus","text":"Status of a Synthetic test.","title":"SyntheticsTestProcessStatus"},{"location":"v1/SyntheticsTestProcessStatus/#properties","text":"Name Type Description Notes value str Status of a Synthetic test. must be one of [\"not_scheduled\", \"scheduled\", \"started\", \"finished\", \"finished_with_error\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestRequest/","text":"SyntheticsTestRequest Object describing the Synthetic test request. Properties Name Type Description Notes basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] certificate SyntheticsTestRequestCertificate [optional] dns_server str DNS server to use for DNS tests. [optional] dns_server_port int DNS server port to use for DNS tests. [optional] headers SyntheticsTestHeaders [optional] host str Host name to perform the test with. [optional] method HTTPMethod [optional] no_saving_response_body bool Determines whether or not to save the response body. [optional] number_of_packets int Number of pings to use per test. [optional] port int Port to use when performing the test. [optional] query {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Query to use for the test. [optional] should_track_hops bool 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 str URL to perform the test with. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestRequest"},{"location":"v1/SyntheticsTestRequest/#syntheticstestrequest","text":"Object describing the Synthetic test request.","title":"SyntheticsTestRequest"},{"location":"v1/SyntheticsTestRequest/#properties","text":"Name Type Description Notes basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] certificate SyntheticsTestRequestCertificate [optional] dns_server str DNS server to use for DNS tests. [optional] dns_server_port int DNS server port to use for DNS tests. [optional] headers SyntheticsTestHeaders [optional] host str Host name to perform the test with. [optional] method HTTPMethod [optional] no_saving_response_body bool Determines whether or not to save the response body. [optional] number_of_packets int Number of pings to use per test. [optional] port int Port to use when performing the test. [optional] query {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Query to use for the test. [optional] should_track_hops bool 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 str URL to perform the test with. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestRequestCertificate/","text":"SyntheticsTestRequestCertificate Client certificate to use when performing the test request. Properties Name Type Description Notes cert SyntheticsTestRequestCertificateItem [optional] key SyntheticsTestRequestCertificateItem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestRequestCertificate"},{"location":"v1/SyntheticsTestRequestCertificate/#syntheticstestrequestcertificate","text":"Client certificate to use when performing the test request.","title":"SyntheticsTestRequestCertificate"},{"location":"v1/SyntheticsTestRequestCertificate/#properties","text":"Name Type Description Notes cert SyntheticsTestRequestCertificateItem [optional] key SyntheticsTestRequestCertificateItem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestRequestCertificateItem/","text":"SyntheticsTestRequestCertificateItem Define a request certificate. Properties Name Type Description Notes content str Content of the certificate or key. [optional] filename str File name for the certificate or key. [optional] updated_at str Date of update of the certificate or key, ISO format. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestRequestCertificateItem"},{"location":"v1/SyntheticsTestRequestCertificateItem/#syntheticstestrequestcertificateitem","text":"Define a request certificate.","title":"SyntheticsTestRequestCertificateItem"},{"location":"v1/SyntheticsTestRequestCertificateItem/#properties","text":"Name Type Description Notes content str Content of the certificate or key. [optional] filename str File name for the certificate or key. [optional] updated_at str Date of update of the certificate or key, ISO format. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTickInterval/","text":"SyntheticsTickInterval The frequency at which to run the Synthetic test (in seconds). Properties Name Type Description Notes value int The frequency at which to run the Synthetic test (in seconds). must be one of [60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTickInterval"},{"location":"v1/SyntheticsTickInterval/#syntheticstickinterval","text":"The frequency at which to run the Synthetic test (in seconds).","title":"SyntheticsTickInterval"},{"location":"v1/SyntheticsTickInterval/#properties","text":"Name Type Description Notes value int The frequency at which to run the Synthetic test (in seconds). must be one of [60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTiming/","text":"SyntheticsTiming Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in Synthetics documentation . 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] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTiming"},{"location":"v1/SyntheticsTiming/#syntheticstiming","text":"Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in Synthetics documentation .","title":"SyntheticsTiming"},{"location":"v1/SyntheticsTiming/#properties","text":"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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTriggerCITestLocation/","text":"SyntheticsTriggerCITestLocation Synthetics location. Properties Name Type Description Notes id int Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTriggerCITestLocation"},{"location":"v1/SyntheticsTriggerCITestLocation/#syntheticstriggercitestlocation","text":"Synthetics location.","title":"SyntheticsTriggerCITestLocation"},{"location":"v1/SyntheticsTriggerCITestLocation/#properties","text":"Name Type Description Notes id int Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTriggerCITestRunResult/","text":"SyntheticsTriggerCITestRunResult Information about a single test run. Properties Name Type Description Notes device SyntheticsDeviceID [optional] location int The location ID of the test run. [optional] public_id str The public ID of the Synthetics test. [optional] result_id str ID of the result. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTriggerCITestRunResult"},{"location":"v1/SyntheticsTriggerCITestRunResult/#syntheticstriggercitestrunresult","text":"Information about a single test run.","title":"SyntheticsTriggerCITestRunResult"},{"location":"v1/SyntheticsTriggerCITestRunResult/#properties","text":"Name Type Description Notes device SyntheticsDeviceID [optional] location int The location ID of the test run. [optional] public_id str The public ID of the Synthetics test. [optional] result_id str ID of the result. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTriggerCITestsResponse/","text":"SyntheticsTriggerCITestsResponse Object containing information about the tests triggered. Properties Name Type Description Notes locations [SyntheticsTriggerCITestLocation] List of Synthetics locations. [optional] results [SyntheticsTriggerCITestRunResult] Information about the tests runs. [optional] triggered_check_ids [str] The public IDs of the Synthetics test triggered. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTriggerCITestsResponse"},{"location":"v1/SyntheticsTriggerCITestsResponse/#syntheticstriggercitestsresponse","text":"Object containing information about the tests triggered.","title":"SyntheticsTriggerCITestsResponse"},{"location":"v1/SyntheticsTriggerCITestsResponse/#properties","text":"Name Type Description Notes locations [SyntheticsTriggerCITestLocation] List of Synthetics locations. [optional] results [SyntheticsTriggerCITestRunResult] Information about the tests runs. [optional] triggered_check_ids [str] The public IDs of the Synthetics test triggered. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsUpdateTestPauseStatusPayload/","text":"SyntheticsUpdateTestPauseStatusPayload Object to start or pause an existing Synthetic test. Properties Name Type Description Notes new_status SyntheticsTestPauseStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsUpdateTestPauseStatusPayload"},{"location":"v1/SyntheticsUpdateTestPauseStatusPayload/#syntheticsupdatetestpausestatuspayload","text":"Object to start or pause an existing Synthetic test.","title":"SyntheticsUpdateTestPauseStatusPayload"},{"location":"v1/SyntheticsUpdateTestPauseStatusPayload/#properties","text":"Name Type Description Notes new_status SyntheticsTestPauseStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsVariableParser/","text":"SyntheticsVariableParser Details of the parser to use for the global variable. Properties Name Type Description Notes type SyntheticsGlobalVariableParserType value str Regex or JSON path used for the parser. Not used with type `raw`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsVariableParser"},{"location":"v1/SyntheticsVariableParser/#syntheticsvariableparser","text":"Details of the parser to use for the global variable.","title":"SyntheticsVariableParser"},{"location":"v1/SyntheticsVariableParser/#properties","text":"Name Type Description Notes type SyntheticsGlobalVariableParserType value str Regex or JSON path used for the parser. Not used with type `raw`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsWarningType/","text":"SyntheticsWarningType User locator used. Properties Name Type Description Notes value str User locator used. defaults to \"user_locator\", must be one of [\"user_locator\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsWarningType"},{"location":"v1/SyntheticsWarningType/#syntheticswarningtype","text":"User locator used.","title":"SyntheticsWarningType"},{"location":"v1/SyntheticsWarningType/#properties","text":"Name Type Description Notes value str User locator used. defaults to \"user_locator\", must be one of [\"user_locator\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetCellDisplayMode/","text":"TableWidgetCellDisplayMode Define a display mode for the table cell. Properties Name Type Description Notes value str Define a display mode for the table cell. must be one of [\"number\", \"bar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetCellDisplayMode"},{"location":"v1/TableWidgetCellDisplayMode/#tablewidgetcelldisplaymode","text":"Define a display mode for the table cell.","title":"TableWidgetCellDisplayMode"},{"location":"v1/TableWidgetCellDisplayMode/#properties","text":"Name Type Description Notes value str Define a display mode for the table cell. must be one of [\"number\", \"bar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetDefinition/","text":"TableWidgetDefinition The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key. Properties Name Type Description Notes requests [TableWidgetRequest] Widget definition. type TableWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] has_search_bar TableWidgetHasSearchBar [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetDefinition"},{"location":"v1/TableWidgetDefinition/#tablewidgetdefinition","text":"The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.","title":"TableWidgetDefinition"},{"location":"v1/TableWidgetDefinition/#properties","text":"Name Type Description Notes requests [TableWidgetRequest] Widget definition. type TableWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] has_search_bar TableWidgetHasSearchBar [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetDefinitionType/","text":"TableWidgetDefinitionType Type of the table widget. Properties Name Type Description Notes value str Type of the table widget. defaults to \"query_table\", must be one of [\"query_table\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetDefinitionType"},{"location":"v1/TableWidgetDefinitionType/#tablewidgetdefinitiontype","text":"Type of the table widget.","title":"TableWidgetDefinitionType"},{"location":"v1/TableWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the table widget. defaults to \"query_table\", must be one of [\"query_table\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetHasSearchBar/","text":"TableWidgetHasSearchBar Controls the display of the search bar. Properties Name Type Description Notes value str Controls the display of the search bar. must be one of [\"always\", \"never\", \"auto\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetHasSearchBar"},{"location":"v1/TableWidgetHasSearchBar/#tablewidgethassearchbar","text":"Controls the display of the search bar.","title":"TableWidgetHasSearchBar"},{"location":"v1/TableWidgetHasSearchBar/#properties","text":"Name Type Description Notes value str Controls the display of the search bar. must be one of [\"always\", \"never\", \"auto\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetRequest/","text":"TableWidgetRequest Updated table widget. Properties Name Type Description Notes aggregator WidgetAggregator [optional] alias str The column name (defaults to the metric name). [optional] apm_query LogQueryDefinition [optional] apm_stats_query ApmStatsQueryDefinition [optional] cell_display_mode [TableWidgetCellDisplayMode] A list of display modes for each table cell. [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] limit int For metric queries, the number of lines to show in the table. Only one request should have this property. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetRequest"},{"location":"v1/TableWidgetRequest/#tablewidgetrequest","text":"Updated table widget.","title":"TableWidgetRequest"},{"location":"v1/TableWidgetRequest/#properties","text":"Name Type Description Notes aggregator WidgetAggregator [optional] alias str The column name (defaults to the metric name). [optional] apm_query LogQueryDefinition [optional] apm_stats_query ApmStatsQueryDefinition [optional] cell_display_mode [TableWidgetCellDisplayMode] A list of display modes for each table cell. [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] limit int For metric queries, the number of lines to show in the table. Only one request should have this property. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TagToHosts/","text":"TagToHosts In this object, the key is the tag, the value is a list of host names that are reporting that tag. Properties Name Type Description Notes tags {str: ([str],)} A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TagToHosts"},{"location":"v1/TagToHosts/#tagtohosts","text":"In this object, the key is the tag, the value is a list of host names that are reporting that tag.","title":"TagToHosts"},{"location":"v1/TagToHosts/#properties","text":"Name Type Description Notes tags {str: ([str],)} A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TagsApi/","text":"datadog_api_client.v1.TagsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags list_host_tags GET /api/v1/tags/hosts Get Tags update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags create_host_tags HostTags create_host_tags(host_name, body) Add tags to a host This endpoint allows you to add new tags to a host, optionally specifying where these tags come from. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Update host tags request body. source = \"chef\" # str | The source of the tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). (optional) # example passing only required values which don't have defaults set try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body HostTags Update host tags request body. source str The source of the tags. Complete list of source attribute values . [optional] Return type HostTags Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_host_tags delete_host_tags(host_name) Remove host tags This endpoint allows you to remove all user-assigned tags for a single host. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to remove all user-assigned tags for a single host. source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Remove host tags api_instance.delete_host_tags(host_name) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Remove host tags api_instance.delete_host_tags(host_name, source=source) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str This endpoint allows you to remove all user-assigned tags for a single host. source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values . [optional] Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_host_tags HostTags get_host_tags(host_name) Get host tags Return the list of tags that apply to a given host. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | When specified, filters list of tags to those tags with the specified source. source = \"source_example\" # str | Source to filter. (optional) # example passing only required values which don't have defaults set try: # Get host tags api_response = api_instance.get_host_tags(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get host tags api_response = api_instance.get_host_tags(host_name, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str When specified, filters list of tags to those tags with the specified source. source str Source to filter. [optional] Return type HostTags Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_host_tags TagToHosts list_host_tags() Get Tags Return a mapping of tags to hosts for your whole infrastructure. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) source = \"source_example\" # str | When specified, filters host list to those tags with the specified source. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get Tags api_response = api_instance.list_host_tags(source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->list_host_tags: %s\\n\" % e) Parameters Name Type Description Notes source str When specified, filters host list to those tags with the specified source. [optional] Return type TagToHosts Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_host_tags HostTags update_host_tags(host_name, body) Update host tags This endpoint allows you to update/replace all tags in an integration source with those supplied in the request. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to update/replace all in an integration source with those supplied in the request. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Add tags to host source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Update host tags api_response = api_instance.update_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update host tags api_response = api_instance.update_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str This endpoint allows you to update/replace all in an integration source with those supplied in the request. body HostTags Add tags to host source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values [optional] Return type HostTags Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.TagsApi"},{"location":"v1/TagsApi/#datadog_api_clientv1tagsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags list_host_tags GET /api/v1/tags/hosts Get Tags update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags","title":"datadog_api_client.v1.TagsApi"},{"location":"v1/TagsApi/#create_host_tags","text":"HostTags create_host_tags(host_name, body) Add tags to a host This endpoint allows you to add new tags to a host, optionally specifying where these tags come from.","title":"create_host_tags"},{"location":"v1/TagsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Update host tags request body. source = \"chef\" # str | The source of the tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). (optional) # example passing only required values which don't have defaults set try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters","text":"Name Type Description Notes host_name str This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body HostTags Update host tags request body. source str The source of the tags. Complete list of source attribute values . [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type","text":"HostTags","title":"Return type"},{"location":"v1/TagsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details","text":"Status code Description Response headers 201 Created - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#delete_host_tags","text":"delete_host_tags(host_name) Remove host tags This endpoint allows you to remove all user-assigned tags for a single host.","title":"delete_host_tags"},{"location":"v1/TagsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to remove all user-assigned tags for a single host. source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Remove host tags api_instance.delete_host_tags(host_name) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Remove host tags api_instance.delete_host_tags(host_name, source=source) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_1","text":"Name Type Description Notes host_name str This endpoint allows you to remove all user-assigned tags for a single host. source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values . [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/TagsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#get_host_tags","text":"HostTags get_host_tags(host_name) Get host tags Return the list of tags that apply to a given host.","title":"get_host_tags"},{"location":"v1/TagsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | When specified, filters list of tags to those tags with the specified source. source = \"source_example\" # str | Source to filter. (optional) # example passing only required values which don't have defaults set try: # Get host tags api_response = api_instance.get_host_tags(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get host tags api_response = api_instance.get_host_tags(host_name, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_2","text":"Name Type Description Notes host_name str When specified, filters list of tags to those tags with the specified source. source str Source to filter. [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_2","text":"HostTags","title":"Return type"},{"location":"v1/TagsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#list_host_tags","text":"TagToHosts list_host_tags() Get Tags Return a mapping of tags to hosts for your whole infrastructure.","title":"list_host_tags"},{"location":"v1/TagsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) source = \"source_example\" # str | When specified, filters host list to those tags with the specified source. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get Tags api_response = api_instance.list_host_tags(source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->list_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_3","text":"Name Type Description Notes source str When specified, filters host list to those tags with the specified source. [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_3","text":"TagToHosts","title":"Return type"},{"location":"v1/TagsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#update_host_tags","text":"HostTags update_host_tags(host_name, body) Update host tags This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.","title":"update_host_tags"},{"location":"v1/TagsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to update/replace all in an integration source with those supplied in the request. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Add tags to host source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Update host tags api_response = api_instance.update_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update host tags api_response = api_instance.update_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_4","text":"Name Type Description Notes host_name str This endpoint allows you to update/replace all in an integration source with those supplied in the request. body HostTags Add tags to host source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_4","text":"HostTags","title":"Return type"},{"location":"v1/TagsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_4","text":"Status code Description Response headers 201 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TargetFormatType/","text":"TargetFormatType If the target_type of the remapper is attribute , try to cast the value to a new specific type. If the cast is not possible, the original type is kept. string , integer , or double are the possible types. If the target_type is tag , this parameter may not be specified. Properties Name Type Description Notes value str If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. must be one of [\"auto\", \"string\", \"integer\", \"double\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TargetFormatType"},{"location":"v1/TargetFormatType/#targetformattype","text":"If the target_type of the remapper is attribute , try to cast the value to a new specific type. If the cast is not possible, the original type is kept. string , integer , or double are the possible types. If the target_type is tag , this parameter may not be specified.","title":"TargetFormatType"},{"location":"v1/TargetFormatType/#properties","text":"Name Type Description Notes value str If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. must be one of [\"auto\", \"string\", \"integer\", \"double\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetDefinition/","text":"TimeseriesWidgetDefinition The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. Properties Name Type Description Notes requests [TimeseriesWidgetRequest] List of timeseries widget requests. type TimeseriesWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] right_yaxis WidgetAxis [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetDefinition"},{"location":"v1/TimeseriesWidgetDefinition/#timeserieswidgetdefinition","text":"The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.","title":"TimeseriesWidgetDefinition"},{"location":"v1/TimeseriesWidgetDefinition/#properties","text":"Name Type Description Notes requests [TimeseriesWidgetRequest] List of timeseries widget requests. type TimeseriesWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] right_yaxis WidgetAxis [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetDefinitionType/","text":"TimeseriesWidgetDefinitionType Type of the timeseries widget. Properties Name Type Description Notes value str Type of the timeseries widget. defaults to \"timeseries\", must be one of [\"timeseries\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetDefinitionType"},{"location":"v1/TimeseriesWidgetDefinitionType/#timeserieswidgetdefinitiontype","text":"Type of the timeseries widget.","title":"TimeseriesWidgetDefinitionType"},{"location":"v1/TimeseriesWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the timeseries widget. defaults to \"timeseries\", must be one of [\"timeseries\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetExpressionAlias/","text":"TimeseriesWidgetExpressionAlias Define an expression alias. Properties Name Type Description Notes expression str Expression name. alias_name str Expression alias. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetExpressionAlias"},{"location":"v1/TimeseriesWidgetExpressionAlias/#timeserieswidgetexpressionalias","text":"Define an expression alias.","title":"TimeseriesWidgetExpressionAlias"},{"location":"v1/TimeseriesWidgetExpressionAlias/#properties","text":"Name Type Description Notes expression str Expression name. alias_name str Expression alias. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetLegendColumn/","text":"TimeseriesWidgetLegendColumn Legend column. Properties Name Type Description Notes value str Legend column. must be one of [\"value\", \"avg\", \"sum\", \"min\", \"max\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetLegendColumn"},{"location":"v1/TimeseriesWidgetLegendColumn/#timeserieswidgetlegendcolumn","text":"Legend column.","title":"TimeseriesWidgetLegendColumn"},{"location":"v1/TimeseriesWidgetLegendColumn/#properties","text":"Name Type Description Notes value str Legend column. must be one of [\"value\", \"avg\", \"sum\", \"min\", \"max\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetLegendLayout/","text":"TimeseriesWidgetLegendLayout Layout of the legend. Properties Name Type Description Notes value str Layout of the legend. must be one of [\"auto\", \"horizontal\", \"vertical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetLegendLayout"},{"location":"v1/TimeseriesWidgetLegendLayout/#timeserieswidgetlegendlayout","text":"Layout of the legend.","title":"TimeseriesWidgetLegendLayout"},{"location":"v1/TimeseriesWidgetLegendLayout/#properties","text":"Name Type Description Notes value str Layout of the legend. must be one of [\"auto\", \"horizontal\", \"vertical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetRequest/","text":"TimeseriesWidgetRequest Updated timeseries widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] display_type WidgetDisplayType [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] metadata [TimeseriesWidgetExpressionAlias] Used to define expression aliases. [optional] network_query LogQueryDefinition [optional] on_right_yaxis bool Whether or not to display a second y-axis on the right. [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetRequest"},{"location":"v1/TimeseriesWidgetRequest/#timeserieswidgetrequest","text":"Updated timeseries widget.","title":"TimeseriesWidgetRequest"},{"location":"v1/TimeseriesWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] display_type WidgetDisplayType [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] metadata [TimeseriesWidgetExpressionAlias] Used to define expression aliases. [optional] network_query LogQueryDefinition [optional] on_right_yaxis bool Whether or not to display a second y-axis on the right. [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ToplistWidgetDefinition/","text":"ToplistWidgetDefinition The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. Properties Name Type Description Notes requests [ToplistWidgetRequest] List of top list widget requests. type ToplistWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ToplistWidgetDefinition"},{"location":"v1/ToplistWidgetDefinition/#toplistwidgetdefinition","text":"The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.","title":"ToplistWidgetDefinition"},{"location":"v1/ToplistWidgetDefinition/#properties","text":"Name Type Description Notes requests [ToplistWidgetRequest] List of top list widget requests. type ToplistWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ToplistWidgetDefinitionType/","text":"ToplistWidgetDefinitionType Type of the top list widget. Properties Name Type Description Notes value str Type of the top list widget. defaults to \"toplist\", must be one of [\"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ToplistWidgetDefinitionType"},{"location":"v1/ToplistWidgetDefinitionType/#toplistwidgetdefinitiontype","text":"Type of the top list widget.","title":"ToplistWidgetDefinitionType"},{"location":"v1/ToplistWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the top list widget. defaults to \"toplist\", must be one of [\"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ToplistWidgetRequest/","text":"ToplistWidgetRequest Updated top list widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ToplistWidgetRequest"},{"location":"v1/ToplistWidgetRequest/#toplistwidgetrequest","text":"Updated top list widget.","title":"ToplistWidgetRequest"},{"location":"v1/ToplistWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAnalyzedLogsHour/","text":"UsageAnalyzedLogsHour The number of analyzed logs for each hour for a given organization. Properties Name Type Description Notes analyzed_logs int Contains the number of analyzed logs. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAnalyzedLogsHour"},{"location":"v1/UsageAnalyzedLogsHour/#usageanalyzedlogshour","text":"The number of analyzed logs for each hour for a given organization.","title":"UsageAnalyzedLogsHour"},{"location":"v1/UsageAnalyzedLogsHour/#properties","text":"Name Type Description Notes analyzed_logs int Contains the number of analyzed logs. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAnalyzedLogsResponse/","text":"UsageAnalyzedLogsResponse A response containing the number of analyzed logs for each hour for a given organization. Properties Name Type Description Notes usage [UsageAnalyzedLogsHour] Get hourly usage for analyzed logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAnalyzedLogsResponse"},{"location":"v1/UsageAnalyzedLogsResponse/#usageanalyzedlogsresponse","text":"A response containing the number of analyzed logs for each hour for a given organization.","title":"UsageAnalyzedLogsResponse"},{"location":"v1/UsageAnalyzedLogsResponse/#properties","text":"Name Type Description Notes usage [UsageAnalyzedLogsHour] Get hourly usage for analyzed logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionAggregates/","text":"UsageAttributionAggregates An array of available aggregates. Properties Name Type Description Notes value [UsageAttributionAggregatesBody] An array of available aggregates. [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionAggregates"},{"location":"v1/UsageAttributionAggregates/#usageattributionaggregates","text":"An array of available aggregates.","title":"UsageAttributionAggregates"},{"location":"v1/UsageAttributionAggregates/#properties","text":"Name Type Description Notes value [UsageAttributionAggregatesBody] An array of available aggregates. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionAggregatesBody/","text":"UsageAttributionAggregatesBody The object containing the aggregates. Properties Name Type Description Notes agg_type str The aggregate type. [optional] field str The field. [optional] value float The value for a given field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionAggregatesBody"},{"location":"v1/UsageAttributionAggregatesBody/#usageattributionaggregatesbody","text":"The object containing the aggregates.","title":"UsageAttributionAggregatesBody"},{"location":"v1/UsageAttributionAggregatesBody/#properties","text":"Name Type Description Notes agg_type str The aggregate type. [optional] field str The field. [optional] value float The value for a given field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionBody/","text":"UsageAttributionBody Usage Summary by tag for a given organization. Properties Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. [optional] org_name str The name of the organization. [optional] public_id str The organization public ID. [optional] tags UsageAttributionTagNames [optional] updated_at str Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional] values UsageAttributionValues [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionBody"},{"location":"v1/UsageAttributionBody/#usageattributionbody","text":"Usage Summary by tag for a given organization.","title":"UsageAttributionBody"},{"location":"v1/UsageAttributionBody/#properties","text":"Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. [optional] org_name str The name of the organization. [optional] public_id str The organization public ID. [optional] tags UsageAttributionTagNames [optional] updated_at str Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional] values UsageAttributionValues [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionMetadata/","text":"UsageAttributionMetadata The object containing document metadata. Properties Name Type Description Notes aggregates UsageAttributionAggregates [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionMetadata"},{"location":"v1/UsageAttributionMetadata/#usageattributionmetadata","text":"The object containing document metadata.","title":"UsageAttributionMetadata"},{"location":"v1/UsageAttributionMetadata/#properties","text":"Name Type Description Notes aggregates UsageAttributionAggregates [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionPagination/","text":"UsageAttributionPagination The page count for the current pagination. Properties Name Type Description Notes limit int Maximum amount of records to be returned. [optional] offset int Records to be skipped before beginning to return. [optional] sort_direction str Direction to sort by. [optional] sort_name str Field to sort by. [optional] total_number_of_records int Total number of records. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionPagination"},{"location":"v1/UsageAttributionPagination/#usageattributionpagination","text":"The page count for the current pagination.","title":"UsageAttributionPagination"},{"location":"v1/UsageAttributionPagination/#properties","text":"Name Type Description Notes limit int Maximum amount of records to be returned. [optional] offset int Records to be skipped before beginning to return. [optional] sort_direction str Direction to sort by. [optional] sort_name str Field to sort by. [optional] total_number_of_records int Total number of records. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionResponse/","text":"UsageAttributionResponse Response containing the Usage Summary by tag(s). Properties Name Type Description Notes metadata UsageAttributionMetadata [optional] usage [UsageAttributionBody] Get Usage Summary by tag(s). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionResponse"},{"location":"v1/UsageAttributionResponse/#usageattributionresponse","text":"Response containing the Usage Summary by tag(s).","title":"UsageAttributionResponse"},{"location":"v1/UsageAttributionResponse/#properties","text":"Name Type Description Notes metadata UsageAttributionMetadata [optional] usage [UsageAttributionBody] Get Usage Summary by tag(s). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionSort/","text":"UsageAttributionSort The field to sort by. Properties Name Type Description Notes value str The field to sort by. defaults to \"custom_timeseries_usage\", must be one of [\"api_percentage\", \"snmp_usage\", \"apm_host_usage\", \"api_usage\", \"container_usage\", \"custom_timeseries_percentage\", \"container_percentage\", \"apm_host_percentage\", \"npm_host_percentage\", \"browser_percentage\", \"browser_usage\", \"infra_host_percentage\", \"snmp_percentage\", \"npm_host_usage\", \"infra_host_usage\", \"custom_timeseries_usage\", \"lambda_functions_usage\", \"lambda_functions_percentage\", \"lambda_invocations_usage\", \"lambda_invocations_percentage\", \"lambda_usage\", \"lambda_percentage\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionSort"},{"location":"v1/UsageAttributionSort/#usageattributionsort","text":"The field to sort by.","title":"UsageAttributionSort"},{"location":"v1/UsageAttributionSort/#properties","text":"Name Type Description Notes value str The field to sort by. defaults to \"custom_timeseries_usage\", must be one of [\"api_percentage\", \"snmp_usage\", \"apm_host_usage\", \"api_usage\", \"container_usage\", \"custom_timeseries_percentage\", \"container_percentage\", \"apm_host_percentage\", \"npm_host_percentage\", \"browser_percentage\", \"browser_usage\", \"infra_host_percentage\", \"snmp_percentage\", \"npm_host_usage\", \"infra_host_usage\", \"custom_timeseries_usage\", \"lambda_functions_usage\", \"lambda_functions_percentage\", \"lambda_invocations_usage\", \"lambda_invocations_percentage\", \"lambda_usage\", \"lambda_percentage\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionTagNames/","text":"UsageAttributionTagNames Usage Summary by tag name. Properties Name Type Description Notes any string name [str] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionTagNames"},{"location":"v1/UsageAttributionTagNames/#usageattributiontagnames","text":"Usage Summary by tag name.","title":"UsageAttributionTagNames"},{"location":"v1/UsageAttributionTagNames/#properties","text":"Name Type Description Notes any string name [str] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionValues/","text":"UsageAttributionValues Fields in Usage Summary by tag(s). 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] 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] 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_containers_percentage float The percentage of profiled containers usage by tag(s). [optional] profiled_containers_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] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionValues"},{"location":"v1/UsageAttributionValues/#usageattributionvalues","text":"Fields in Usage Summary by tag(s).","title":"UsageAttributionValues"},{"location":"v1/UsageAttributionValues/#properties","text":"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] 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] 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_containers_percentage float The percentage of profiled containers usage by tag(s). [optional] profiled_containers_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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryBody/","text":"UsageBillableSummaryBody Response with properties for each aggregated usage type. Properties Name Type Description Notes account_billable_usage int The total account usage. [optional] elapsed_usage_hours int Elapsed usage hours for some billable product. [optional] first_billable_usage_hour datetime The first billable hour for the org. [optional] last_billable_usage_hour datetime The last billable hour for the org. [optional] org_billable_usage int 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 str Units pertaining to the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryBody"},{"location":"v1/UsageBillableSummaryBody/#usagebillablesummarybody","text":"Response with properties for each aggregated usage type.","title":"UsageBillableSummaryBody"},{"location":"v1/UsageBillableSummaryBody/#properties","text":"Name Type Description Notes account_billable_usage int The total account usage. [optional] elapsed_usage_hours int Elapsed usage hours for some billable product. [optional] first_billable_usage_hour datetime The first billable hour for the org. [optional] last_billable_usage_hour datetime The last billable hour for the org. [optional] org_billable_usage int 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 str Units pertaining to the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryHour/","text":"UsageBillableSummaryHour Response with monthly summary of data billed by Datadog. Properties Name Type Description Notes billing_plan str The billing plan. [optional] end_date datetime Shows the last date of usage. [optional] num_orgs int The number of organizations. [optional] org_name str The organization name. [optional] public_id str The organization public ID. [optional] ratio_in_month int Shows usage aggregation for a billing period. [optional] start_date datetime Shows the first date of usage. [optional] usage UsageBillableSummaryKeys [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryHour"},{"location":"v1/UsageBillableSummaryHour/#usagebillablesummaryhour","text":"Response with monthly summary of data billed by Datadog.","title":"UsageBillableSummaryHour"},{"location":"v1/UsageBillableSummaryHour/#properties","text":"Name Type Description Notes billing_plan str The billing plan. [optional] end_date datetime Shows the last date of usage. [optional] num_orgs int The number of organizations. [optional] org_name str The organization name. [optional] public_id str The organization public ID. [optional] ratio_in_month int Shows usage aggregation for a billing period. [optional] start_date datetime Shows the first date of usage. [optional] usage UsageBillableSummaryKeys [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryKeys/","text":"UsageBillableSummaryKeys Response with aggregated usage types. Properties Name Type Description Notes apm_host_sum UsageBillableSummaryBody [optional] apm_host_top99p UsageBillableSummaryBody [optional] apm_trace_search_sum UsageBillableSummaryBody [optional] fargate_container_average UsageBillableSummaryBody [optional] infra_container_sum UsageBillableSummaryBody [optional] infra_host_sum UsageBillableSummaryBody [optional] infra_host_top99p UsageBillableSummaryBody [optional] iot_top99p UsageBillableSummaryBody [optional] lambda_function_average UsageBillableSummaryBody [optional] logs_indexed_sum UsageBillableSummaryBody [optional] logs_ingested_sum UsageBillableSummaryBody [optional] npm_flow_sum UsageBillableSummaryBody [optional] npm_host_top99p UsageBillableSummaryBody [optional] rum_sum UsageBillableSummaryBody [optional] serverless_invocation_sum UsageBillableSummaryBody [optional] siem_sum UsageBillableSummaryBody [optional] synthetics_api_tests_sum UsageBillableSummaryBody [optional] synthetics_browser_checks_sum UsageBillableSummaryBody [optional] timeseries_average UsageBillableSummaryBody [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryKeys"},{"location":"v1/UsageBillableSummaryKeys/#usagebillablesummarykeys","text":"Response with aggregated usage types.","title":"UsageBillableSummaryKeys"},{"location":"v1/UsageBillableSummaryKeys/#properties","text":"Name Type Description Notes apm_host_sum UsageBillableSummaryBody [optional] apm_host_top99p UsageBillableSummaryBody [optional] apm_trace_search_sum UsageBillableSummaryBody [optional] fargate_container_average UsageBillableSummaryBody [optional] infra_container_sum UsageBillableSummaryBody [optional] infra_host_sum UsageBillableSummaryBody [optional] infra_host_top99p UsageBillableSummaryBody [optional] iot_top99p UsageBillableSummaryBody [optional] lambda_function_average UsageBillableSummaryBody [optional] logs_indexed_sum UsageBillableSummaryBody [optional] logs_ingested_sum UsageBillableSummaryBody [optional] npm_flow_sum UsageBillableSummaryBody [optional] npm_host_top99p UsageBillableSummaryBody [optional] rum_sum UsageBillableSummaryBody [optional] serverless_invocation_sum UsageBillableSummaryBody [optional] siem_sum UsageBillableSummaryBody [optional] synthetics_api_tests_sum UsageBillableSummaryBody [optional] synthetics_browser_checks_sum UsageBillableSummaryBody [optional] timeseries_average UsageBillableSummaryBody [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryResponse/","text":"UsageBillableSummaryResponse Response with monthly summary of data billed by Datadog. Properties Name Type Description Notes usage [UsageBillableSummaryHour] An array of objects regarding usage of billable summary. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryResponse"},{"location":"v1/UsageBillableSummaryResponse/#usagebillablesummaryresponse","text":"Response with monthly summary of data billed by Datadog.","title":"UsageBillableSummaryResponse"},{"location":"v1/UsageBillableSummaryResponse/#properties","text":"Name Type Description Notes usage [UsageBillableSummaryHour] An array of objects regarding usage of billable summary. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageComplianceHour/","text":"UsageComplianceHour Compliance Monitoring usage for a given organization for a given hour. Properties Name Type Description Notes compliance_container_count int The total number of compliance container hours from the start of the given hour's month until the given hour. [optional] compliance_host_count int The total number of compliance hosts hours from the start of the given hour's month until the given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageComplianceHour"},{"location":"v1/UsageComplianceHour/#usagecompliancehour","text":"Compliance Monitoring usage for a given organization for a given hour.","title":"UsageComplianceHour"},{"location":"v1/UsageComplianceHour/#properties","text":"Name Type Description Notes compliance_container_count int The total number of compliance container hours from the start of the given hour's month until the given hour. [optional] compliance_host_count int The total number of compliance hosts hours from the start of the given hour's month until the given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageComplianceResponse/","text":"UsageComplianceResponse The response containing the Compliance Monitoring usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageComplianceHour] Get hourly usage for Compliance Monitoring. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageComplianceResponse"},{"location":"v1/UsageComplianceResponse/#usagecomplianceresponse","text":"The response containing the Compliance Monitoring usage for each hour for a given organization.","title":"UsageComplianceResponse"},{"location":"v1/UsageComplianceResponse/#properties","text":"Name Type Description Notes usage [UsageComplianceHour] Get hourly usage for Compliance Monitoring. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsAttributes/","text":"UsageCustomReportsAttributes The response containing attributes for custom reports. Properties Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of custom report. [optional] size int size [optional] start_date str The starting date of custom report. [optional] tags [str] A list of tags to apply to custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsAttributes"},{"location":"v1/UsageCustomReportsAttributes/#usagecustomreportsattributes","text":"The response containing attributes for custom reports.","title":"UsageCustomReportsAttributes"},{"location":"v1/UsageCustomReportsAttributes/#properties","text":"Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of custom report. [optional] size int size [optional] start_date str The starting date of custom report. [optional] tags [str] A list of tags to apply to custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsData/","text":"UsageCustomReportsData The response containing the date and type for custom reports. Properties Name Type Description Notes attributes UsageCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsData"},{"location":"v1/UsageCustomReportsData/#usagecustomreportsdata","text":"The response containing the date and type for custom reports.","title":"UsageCustomReportsData"},{"location":"v1/UsageCustomReportsData/#properties","text":"Name Type Description Notes attributes UsageCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsMeta/","text":"UsageCustomReportsMeta The object containing document metadata. Properties Name Type Description Notes page UsageCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsMeta"},{"location":"v1/UsageCustomReportsMeta/#usagecustomreportsmeta","text":"The object containing document metadata.","title":"UsageCustomReportsMeta"},{"location":"v1/UsageCustomReportsMeta/#properties","text":"Name Type Description Notes page UsageCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsPage/","text":"UsageCustomReportsPage The object containing page total count. Properties Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsPage"},{"location":"v1/UsageCustomReportsPage/#usagecustomreportspage","text":"The object containing page total count.","title":"UsageCustomReportsPage"},{"location":"v1/UsageCustomReportsPage/#properties","text":"Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsResponse/","text":"UsageCustomReportsResponse Response containing available custom reports. Properties Name Type Description Notes data [UsageCustomReportsData] An array of available custom reports. [optional] meta UsageCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsResponse"},{"location":"v1/UsageCustomReportsResponse/#usagecustomreportsresponse","text":"Response containing available custom reports.","title":"UsageCustomReportsResponse"},{"location":"v1/UsageCustomReportsResponse/#properties","text":"Name Type Description Notes data [UsageCustomReportsData] An array of available custom reports. [optional] meta UsageCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageFargateHour/","text":"UsageFargateHour Number of Fargate tasks run and hourly usage. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] tasks_count int The number of Fargate tasks run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageFargateHour"},{"location":"v1/UsageFargateHour/#usagefargatehour","text":"Number of Fargate tasks run and hourly usage.","title":"UsageFargateHour"},{"location":"v1/UsageFargateHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] tasks_count int The number of Fargate tasks run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageFargateResponse/","text":"UsageFargateResponse Response containing the number of Fargate tasks run and hourly usage. Properties Name Type Description Notes usage [UsageFargateHour] Array with the number of hourly Fargate tasks recorded for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageFargateResponse"},{"location":"v1/UsageFargateResponse/#usagefargateresponse","text":"Response containing the number of Fargate tasks run and hourly usage.","title":"UsageFargateResponse"},{"location":"v1/UsageFargateResponse/#properties","text":"Name Type Description Notes usage [UsageFargateHour] Array with the number of hourly Fargate tasks recorded for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageHostHour/","text":"UsageHostHour Number of hosts/containers recorded for each hour for a given organization. Properties Name Type Description Notes agent_host_count int Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. [optional] alibaba_host_count int 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 int Contains the total number of Azure App Services hosts using APM. [optional] apm_host_count int Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). [optional] aws_host_count int Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). [optional] azure_host_count int Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). [optional] container_count int Shows the total number of containers reported by the Docker integration during the hour. [optional] gcp_host_count int Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). [optional] heroku_host_count int Contains the total number of Heroku dynos reported by the Datadog Agent. [optional] host_count int 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 datetime The hour for the usage. [optional] infra_azure_app_service int 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 int Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. [optional] vsphere_host_count int Contains the total number of hosts that reported via vSphere integration (and were NOT running the Datadog Agent). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageHostHour"},{"location":"v1/UsageHostHour/#usagehosthour","text":"Number of hosts/containers recorded for each hour for a given organization.","title":"UsageHostHour"},{"location":"v1/UsageHostHour/#properties","text":"Name Type Description Notes agent_host_count int Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. [optional] alibaba_host_count int 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 int Contains the total number of Azure App Services hosts using APM. [optional] apm_host_count int Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). [optional] aws_host_count int Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). [optional] azure_host_count int Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). [optional] container_count int Shows the total number of containers reported by the Docker integration during the hour. [optional] gcp_host_count int Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). [optional] heroku_host_count int Contains the total number of Heroku dynos reported by the Datadog Agent. [optional] host_count int 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 datetime The hour for the usage. [optional] infra_azure_app_service int 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 int Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. [optional] vsphere_host_count int Contains the total number of hosts that reported via vSphere integration (and were NOT running the Datadog Agent). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageHostsResponse/","text":"UsageHostsResponse Host usage response. Properties Name Type Description Notes usage [UsageHostHour] An array of objects related to host usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageHostsResponse"},{"location":"v1/UsageHostsResponse/#usagehostsresponse","text":"Host usage response.","title":"UsageHostsResponse"},{"location":"v1/UsageHostsResponse/#properties","text":"Name Type Description Notes usage [UsageHostHour] An array of objects related to host usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIncidentManagementHour/","text":"UsageIncidentManagementHour Incident management usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] monthly_active_users int Contains the total number monthly active users from the start of the given hour's month until the given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIncidentManagementHour"},{"location":"v1/UsageIncidentManagementHour/#usageincidentmanagementhour","text":"Incident management usage for a given organization for a given hour.","title":"UsageIncidentManagementHour"},{"location":"v1/UsageIncidentManagementHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] monthly_active_users int Contains the total number monthly active users from the start of the given hour's month until the given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIncidentManagementResponse/","text":"UsageIncidentManagementResponse Response containing the incident management usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageIncidentManagementHour] Get hourly usage for incident management. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIncidentManagementResponse"},{"location":"v1/UsageIncidentManagementResponse/#usageincidentmanagementresponse","text":"Response containing the incident management usage for each hour for a given organization.","title":"UsageIncidentManagementResponse"},{"location":"v1/UsageIncidentManagementResponse/#properties","text":"Name Type Description Notes usage [UsageIncidentManagementHour] Get hourly usage for incident management. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIndexedSpansHour/","text":"UsageIndexedSpansHour The hours of indexed spans usage. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIndexedSpansHour"},{"location":"v1/UsageIndexedSpansHour/#usageindexedspanshour","text":"The hours of indexed spans usage.","title":"UsageIndexedSpansHour"},{"location":"v1/UsageIndexedSpansHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIndexedSpansResponse/","text":"UsageIndexedSpansResponse A response containing indexed spans usage. Properties Name Type Description Notes usage [UsageIndexedSpansHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIndexedSpansResponse"},{"location":"v1/UsageIndexedSpansResponse/#usageindexedspansresponse","text":"A response containing indexed spans usage.","title":"UsageIndexedSpansResponse"},{"location":"v1/UsageIndexedSpansResponse/#properties","text":"Name Type Description Notes usage [UsageIndexedSpansHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIngestedSpansHour/","text":"UsageIngestedSpansHour Ingested spans usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIngestedSpansHour"},{"location":"v1/UsageIngestedSpansHour/#usageingestedspanshour","text":"Ingested spans usage for a given organization for a given hour.","title":"UsageIngestedSpansHour"},{"location":"v1/UsageIngestedSpansHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIngestedSpansResponse/","text":"UsageIngestedSpansResponse Response containing the ingested spans usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageIngestedSpansHour] Get hourly usage for ingested spans. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIngestedSpansResponse"},{"location":"v1/UsageIngestedSpansResponse/#usageingestedspansresponse","text":"Response containing the ingested spans usage for each hour for a given organization.","title":"UsageIngestedSpansResponse"},{"location":"v1/UsageIngestedSpansResponse/#properties","text":"Name Type Description Notes usage [UsageIngestedSpansHour] Get hourly usage for ingested spans. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIoTHour/","text":"UsageIoTHour IoT usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] iot_device_count int The total number of IoT devices during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIoTHour"},{"location":"v1/UsageIoTHour/#usageiothour","text":"IoT usage for a given organization for a given hour.","title":"UsageIoTHour"},{"location":"v1/UsageIoTHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] iot_device_count int The total number of IoT devices during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIoTResponse/","text":"UsageIoTResponse Response containing the IoT usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageIoTHour] Get hourly usage for IoT. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIoTResponse"},{"location":"v1/UsageIoTResponse/#usageiotresponse","text":"Response containing the IoT usage for each hour for a given organization.","title":"UsageIoTResponse"},{"location":"v1/UsageIoTResponse/#properties","text":"Name Type Description Notes usage [UsageIoTHour] Get hourly usage for IoT. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLambdaHour/","text":"UsageLambdaHour Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization. Properties Name Type Description Notes func_count int Contains the number of different functions for each region and AWS account. [optional] hour datetime The hour for the usage. [optional] invocations_sum int Contains the sum of invocations of all functions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLambdaHour"},{"location":"v1/UsageLambdaHour/#usagelambdahour","text":"Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.","title":"UsageLambdaHour"},{"location":"v1/UsageLambdaHour/#properties","text":"Name Type Description Notes func_count int Contains the number of different functions for each region and AWS account. [optional] hour datetime The hour for the usage. [optional] invocations_sum int Contains the sum of invocations of all functions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLambdaResponse/","text":"UsageLambdaResponse Response containing the number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization. Properties Name Type Description Notes usage [UsageLambdaHour] Get hourly usage for Lambda. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLambdaResponse"},{"location":"v1/UsageLambdaResponse/#usagelambdaresponse","text":"Response containing the number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.","title":"UsageLambdaResponse"},{"location":"v1/UsageLambdaResponse/#properties","text":"Name Type Description Notes usage [UsageLambdaHour] Get hourly usage for Lambda. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByIndexHour/","text":"UsageLogsByIndexHour Number of indexed logs for each hour and index for a given organization. Properties Name Type Description Notes event_count int The total number of indexed logs for the queried hour. [optional] hour datetime The hour for the usage. [optional] index_id str The index ID for this usage. [optional] index_name str The user specified name for this index ID. [optional] retention int The retention period (in days) for this index ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByIndexHour"},{"location":"v1/UsageLogsByIndexHour/#usagelogsbyindexhour","text":"Number of indexed logs for each hour and index for a given organization.","title":"UsageLogsByIndexHour"},{"location":"v1/UsageLogsByIndexHour/#properties","text":"Name Type Description Notes event_count int The total number of indexed logs for the queried hour. [optional] hour datetime The hour for the usage. [optional] index_id str The index ID for this usage. [optional] index_name str The user specified name for this index ID. [optional] retention int The retention period (in days) for this index ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByIndexResponse/","text":"UsageLogsByIndexResponse Response containing the number of indexed logs for each hour and index for a given organization. Properties Name Type Description Notes usage [UsageLogsByIndexHour] An array of objects regarding hourly usage of logs by index response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByIndexResponse"},{"location":"v1/UsageLogsByIndexResponse/#usagelogsbyindexresponse","text":"Response containing the number of indexed logs for each hour and index for a given organization.","title":"UsageLogsByIndexResponse"},{"location":"v1/UsageLogsByIndexResponse/#properties","text":"Name Type Description Notes usage [UsageLogsByIndexHour] An array of objects regarding hourly usage of logs by index response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByRetentionHour/","text":"UsageLogsByRetentionHour The number of indexed logs for each hour for a given organization broken down by retention period. Properties Name Type Description Notes indexed_events_count int Total logs indexed with this retention period during a given hour. [optional] live_indexed_events_count int Live logs indexed with this retention period during a given hour. [optional] rehydrated_indexed_events_count int Rehydrated logs indexed with this retention period during a given hour. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByRetentionHour"},{"location":"v1/UsageLogsByRetentionHour/#usagelogsbyretentionhour","text":"The number of indexed logs for each hour for a given organization broken down by retention period.","title":"UsageLogsByRetentionHour"},{"location":"v1/UsageLogsByRetentionHour/#properties","text":"Name Type Description Notes indexed_events_count int Total logs indexed with this retention period during a given hour. [optional] live_indexed_events_count int Live logs indexed with this retention period during a given hour. [optional] rehydrated_indexed_events_count int Rehydrated logs indexed with this retention period during a given hour. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByRetentionResponse/","text":"UsageLogsByRetentionResponse Response containing the indexed logs usage broken down by retention period for an organization during a given hour. Properties Name Type Description Notes usage [UsageLogsByRetentionHour] Get hourly usage for indexed logs by retention period. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByRetentionResponse"},{"location":"v1/UsageLogsByRetentionResponse/#usagelogsbyretentionresponse","text":"Response containing the indexed logs usage broken down by retention period for an organization during a given hour.","title":"UsageLogsByRetentionResponse"},{"location":"v1/UsageLogsByRetentionResponse/#properties","text":"Name Type Description Notes usage [UsageLogsByRetentionHour] Get hourly usage for indexed logs by retention period. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsHour/","text":"UsageLogsHour Hour usage for logs. Properties Name Type Description Notes billable_ingested_bytes int Contains the number of billable log bytes ingested. [optional] hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of log events indexed. [optional] ingested_events_bytes int Contains the number of log bytes ingested. [optional] logs_live_indexed_count int Contains the number of live log events indexed (data available as of December 1, 2020). [optional] logs_live_ingested_bytes int Contains the number of live log bytes ingested (data available as of December 1, 2020). [optional] logs_rehydrated_indexed_count int Contains the number of rehydrated log events indexed (data available as of December 1, 2020). [optional] logs_rehydrated_ingested_bytes int Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsHour"},{"location":"v1/UsageLogsHour/#usagelogshour","text":"Hour usage for logs.","title":"UsageLogsHour"},{"location":"v1/UsageLogsHour/#properties","text":"Name Type Description Notes billable_ingested_bytes int Contains the number of billable log bytes ingested. [optional] hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of log events indexed. [optional] ingested_events_bytes int Contains the number of log bytes ingested. [optional] logs_live_indexed_count int Contains the number of live log events indexed (data available as of December 1, 2020). [optional] logs_live_ingested_bytes int Contains the number of live log bytes ingested (data available as of December 1, 2020). [optional] logs_rehydrated_indexed_count int Contains the number of rehydrated log events indexed (data available as of December 1, 2020). [optional] logs_rehydrated_ingested_bytes int Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsResponse/","text":"UsageLogsResponse Response containing the number of logs for each hour. Properties Name Type Description Notes usage [UsageLogsHour] An array of objects regarding hourly usage of logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsResponse"},{"location":"v1/UsageLogsResponse/#usagelogsresponse","text":"Response containing the number of logs for each hour.","title":"UsageLogsResponse"},{"location":"v1/UsageLogsResponse/#properties","text":"Name Type Description Notes usage [UsageLogsHour] An array of objects regarding hourly usage of logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageMeteringApi/","text":"datadog_api_client.v1.UsageMeteringApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search get_daily_custom_reports UsageCustomReportsResponse get_daily_custom_reports() Get the list of available daily custom reports Get daily custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response. `[default=60]`. (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available daily custom reports api_response = api_instance.get_daily_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_daily_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes page_size int The number of files to return in the response. `[default=60]`. [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional] Return type UsageCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident_management UsageIncidentManagementResponse get_incident_management(start_hr) Get hourly usage for incident management Get hourly usage for incident management. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIncidentManagementResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_ingested_spans UsageIngestedSpansResponse get_ingested_spans(start_hr) Get hourly usage for ingested spans Get hourly usage for ingested spans. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIngestedSpansResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_monthly_custom_reports UsageCustomReportsResponse get_monthly_custom_reports() Get the list of available monthly custom reports Get monthly custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response `[default=60].` (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available monthly custom reports api_response = api_instance.get_monthly_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_monthly_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes page_size int The number of files to return in the response `[default=60].` [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional] Return type UsageCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_specified_daily_custom_reports UsageSpecifiedCustomReportsResponse get_specified_daily_custom_reports(report_id) Get specified daily custom reports Get specified daily custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified daily custom reports api_response = api_instance.get_specified_daily_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_daily_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes report_id str The specified ID to search results for. Return type UsageSpecifiedCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_specified_monthly_custom_reports UsageSpecifiedCustomReportsResponse get_specified_monthly_custom_reports(report_id) Get specified monthly custom reports Get specified monthly custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified monthly custom reports api_response = api_instance.get_specified_monthly_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_monthly_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes report_id str The specified ID to search results for. Return type UsageSpecifiedCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_tracing_without_limits UsageTracingWithoutLimitsResponse get_tracing_without_limits(start_hr) Get hourly usage for tracing without limits Get hourly usage for tracing without limits. Note This endpoint has been renamed to /api/v1/usage/ingested-spans . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageTracingWithoutLimitsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_analyzed_logs UsageAnalyzedLogsResponse get_usage_analyzed_logs(start_hr) Get hourly usage for analyzed logs Get hourly usage for analyzed logs (Security Monitoring). Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageAnalyzedLogsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_attribution UsageAttributionResponse get_usage_attribution(start_month, fields) Get Usage Attribution Get Usage Attribution. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_usage_attribution\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields = \"fields_example\" # str | The specified field to search results for. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) sort_direction = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort_name = UsageAttributionSort(\"custom_timeseries_usage\") # UsageAttributionSort | The field to sort by. (optional) # example passing only required values which don't have defaults set try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields, end_month=end_month, sort_direction=sort_direction, sort_name=sort_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e) Parameters Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields str The specified field to search results for. end_month datetime 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] sort_name UsageAttributionSort The field to sort by. [optional] Return type UsageAttributionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_billable_summary UsageBillableSummaryResponse get_usage_billable_summary() Get billable usage across your account Get billable usage across your account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get billable usage across your account api_response = api_instance.get_usage_billable_summary(month=month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_billable_summary: %s\\n\" % e) Parameters Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. [optional] Return type UsageBillableSummaryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_compliance_monitoring UsageComplianceResponse get_usage_compliance_monitoring(start_hr) Get hourly usage for Compliance Monitoring Get hourly usage for Compliance Monitoring. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageComplianceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_fargate UsageFargateResponse get_usage_fargate(start_hr) Get hourly usage for Fargate Get hourly usage for Fargate . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageFargateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_hosts UsageHostsResponse get_usage_hosts(start_hr) Get hourly usage for hosts and containers Get hourly usage for hosts and containers. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageHostsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_indexed_spans UsageIndexedSpansResponse get_usage_indexed_spans(start_hr) Get hourly usage for indexed spans Get hourly usage for indexed spans. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIndexedSpansResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_internet_of_things UsageIoTResponse get_usage_internet_of_things(start_hr) Get hourly usage for IoT Get hourly usage for IoT. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIoTResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_lambda UsageLambdaResponse get_usage_lambda(start_hr) Get hourly usage for Lambda Get hourly usage for lambda. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageLambdaResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_logs UsageLogsResponse get_usage_logs(start_hr) Get hourly usage for Logs Get hourly usage for logs. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageLogsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_logs_by_index UsageLogsByIndexResponse get_usage_logs_by_index(start_hr) Get hourly usage for Logs by Index Get hourly usage for logs by index. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) index_name = [ \"index_name_example\", ] # [str] | Comma-separated list of log index names. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr, end_hr=end_hr, index_name=index_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] index_name [str] Comma-separated list of log index names. [optional] Return type UsageLogsByIndexResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_logs_by_retention UsageLogsByRetentionResponse get_usage_logs_by_retention(start_hr) Get hourly logs usage by retention Get hourly usage for indexed logs by retention period. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageLogsByRetentionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_network_flows UsageNetworkFlowsResponse get_usage_network_flows(start_hr) Get hourly usage for Network Flows Get hourly usage for network flows. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageNetworkFlowsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_network_hosts UsageNetworkHostsResponse get_usage_network_hosts(start_hr) Get hourly usage for Network Hosts Get hourly usage for network hosts. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageNetworkHostsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_profiling UsageProfilingResponse get_usage_profiling(start_hr) Get hourly usage for profiled hosts Get hourly usage for profiled hosts. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageProfilingResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_rum_sessions UsageRumSessionsResponse get_usage_rum_sessions(start_hr) Get hourly usage for RUM Sessions Get hourly usage for RUM Sessions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) type = \"type_example\" # str | RUM type: `[browser, mobile]`. Defaults to `browser`. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr, end_hr=end_hr, type=type) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] type str RUM type: `[browser, mobile]`. Defaults to `browser`. [optional] Return type UsageRumSessionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_snmp UsageSNMPResponse get_usage_snmp(start_hr) Get hourly usage for SNMP devices Get hourly usage for SNMP devices. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageSNMPResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_summary UsageSummaryResponse get_usage_summary(start_month) Get usage across your multi-org account Get usage across your multi-org account. You must have the multi-org feature enabled. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) include_org_details = True # bool | Include usage summaries for each sub-org. (optional) # example passing only required values which don't have defaults set try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month, end_month=end_month, include_org_details=include_org_details) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e) Parameters Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. [optional] include_org_details bool Include usage summaries for each sub-org. [optional] Return type UsageSummaryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_synthetics UsageSyntheticsResponse get_usage_synthetics(start_hr) Get hourly usage for Synthetics Checks Get hourly usage for Synthetics checks . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageSyntheticsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_synthetics_api UsageSyntheticsAPIResponse get_usage_synthetics_api(start_hr) Get hourly usage for Synthetics API Checks Get hourly usage for synthetics API checks . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageSyntheticsAPIResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_synthetics_browser UsageSyntheticsBrowserResponse get_usage_synthetics_browser(start_hr) Get hourly usage for Synthetics Browser Checks Get hourly usage for synthetics browser checks. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageSyntheticsBrowserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_timeseries UsageTimeseriesResponse get_usage_timeseries(start_hr) Get hourly usage for custom metrics Get hourly usage for custom metrics . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageTimeseriesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_top_avg_metrics UsageTopAvgMetricsResponse get_usage_top_avg_metrics() Get top custom metrics by hourly average Get top custom metrics by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = [ \"names_example\", ] # [str] | Comma-separated list of metric names. (optional) limit = 500 # int | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. (optional) if omitted the server will use the default value of 500 # example passing only required values which don't have defaults set # and optional values try: # Get top custom metrics by hourly average api_response = api_instance.get_usage_top_avg_metrics(month=month, day=day, names=names, limit=limit) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_top_avg_metrics: %s\\n\" % e) Parameters Name Type Description Notes month datetime 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 datetime 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 [str] Comma-separated list of metric names. [optional] limit int Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. [optional] if omitted the server will use the default value of 500 Return type UsageTopAvgMetricsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_trace UsageTraceResponse get_usage_trace(start_hr) Get hourly usage for Trace Search Get hourly usage for trace search. Note This endpoint has been renamed to /api/v1/usage/indexed-spans . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageTraceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.UsageMeteringApi"},{"location":"v1/UsageMeteringApi/#datadog_api_clientv1usagemeteringapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search","title":"datadog_api_client.v1.UsageMeteringApi"},{"location":"v1/UsageMeteringApi/#get_daily_custom_reports","text":"UsageCustomReportsResponse get_daily_custom_reports() Get the list of available daily custom reports Get daily custom reports.","title":"get_daily_custom_reports"},{"location":"v1/UsageMeteringApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response. `[default=60]`. (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available daily custom reports api_response = api_instance.get_daily_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_daily_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters","text":"Name Type Description Notes page_size int The number of files to return in the response. `[default=60]`. [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type","text":"UsageCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_incident_management","text":"UsageIncidentManagementResponse get_incident_management(start_hr) Get hourly usage for incident management Get hourly usage for incident management.","title":"get_incident_management"},{"location":"v1/UsageMeteringApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_1","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_1","text":"UsageIncidentManagementResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_ingested_spans","text":"UsageIngestedSpansResponse get_ingested_spans(start_hr) Get hourly usage for ingested spans Get hourly usage for ingested spans.","title":"get_ingested_spans"},{"location":"v1/UsageMeteringApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_2","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_2","text":"UsageIngestedSpansResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_monthly_custom_reports","text":"UsageCustomReportsResponse get_monthly_custom_reports() Get the list of available monthly custom reports Get monthly custom reports.","title":"get_monthly_custom_reports"},{"location":"v1/UsageMeteringApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response `[default=60].` (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available monthly custom reports api_response = api_instance.get_monthly_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_monthly_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_3","text":"Name Type Description Notes page_size int The number of files to return in the response `[default=60].` [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_3","text":"UsageCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_specified_daily_custom_reports","text":"UsageSpecifiedCustomReportsResponse get_specified_daily_custom_reports(report_id) Get specified daily custom reports Get specified daily custom reports.","title":"get_specified_daily_custom_reports"},{"location":"v1/UsageMeteringApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified daily custom reports api_response = api_instance.get_specified_daily_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_daily_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_4","text":"Name Type Description Notes report_id str The specified ID to search results for.","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_4","text":"UsageSpecifiedCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_specified_monthly_custom_reports","text":"UsageSpecifiedCustomReportsResponse get_specified_monthly_custom_reports(report_id) Get specified monthly custom reports Get specified monthly custom reports.","title":"get_specified_monthly_custom_reports"},{"location":"v1/UsageMeteringApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified monthly custom reports api_response = api_instance.get_specified_monthly_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_monthly_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_5","text":"Name Type Description Notes report_id str The specified ID to search results for.","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_5","text":"UsageSpecifiedCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_tracing_without_limits","text":"UsageTracingWithoutLimitsResponse get_tracing_without_limits(start_hr) Get hourly usage for tracing without limits Get hourly usage for tracing without limits. Note This endpoint has been renamed to /api/v1/usage/ingested-spans .","title":"get_tracing_without_limits"},{"location":"v1/UsageMeteringApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_6","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_6","text":"UsageTracingWithoutLimitsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_analyzed_logs","text":"UsageAnalyzedLogsResponse get_usage_analyzed_logs(start_hr) Get hourly usage for analyzed logs Get hourly usage for analyzed logs (Security Monitoring).","title":"get_usage_analyzed_logs"},{"location":"v1/UsageMeteringApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_7","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_7","text":"UsageAnalyzedLogsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_attribution","text":"UsageAttributionResponse get_usage_attribution(start_month, fields) Get Usage Attribution Get Usage Attribution.","title":"get_usage_attribution"},{"location":"v1/UsageMeteringApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_usage_attribution\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields = \"fields_example\" # str | The specified field to search results for. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) sort_direction = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort_name = UsageAttributionSort(\"custom_timeseries_usage\") # UsageAttributionSort | The field to sort by. (optional) # example passing only required values which don't have defaults set try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields, end_month=end_month, sort_direction=sort_direction, sort_name=sort_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_8","text":"Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields str The specified field to search results for. end_month datetime 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] sort_name UsageAttributionSort The field to sort by. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_8","text":"UsageAttributionResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_billable_summary","text":"UsageBillableSummaryResponse get_usage_billable_summary() Get billable usage across your account Get billable usage across your account.","title":"get_usage_billable_summary"},{"location":"v1/UsageMeteringApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get billable usage across your account api_response = api_instance.get_usage_billable_summary(month=month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_billable_summary: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_9","text":"Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_9","text":"UsageBillableSummaryResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_9","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_compliance_monitoring","text":"UsageComplianceResponse get_usage_compliance_monitoring(start_hr) Get hourly usage for Compliance Monitoring Get hourly usage for Compliance Monitoring.","title":"get_usage_compliance_monitoring"},{"location":"v1/UsageMeteringApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_10","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_10","text":"UsageComplianceResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_10","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_fargate","text":"UsageFargateResponse get_usage_fargate(start_hr) Get hourly usage for Fargate Get hourly usage for Fargate .","title":"get_usage_fargate"},{"location":"v1/UsageMeteringApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_11","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_11","text":"UsageFargateResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_11","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_hosts","text":"UsageHostsResponse get_usage_hosts(start_hr) Get hourly usage for hosts and containers Get hourly usage for hosts and containers.","title":"get_usage_hosts"},{"location":"v1/UsageMeteringApi/#example_12","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_12","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_12","text":"UsageHostsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_12","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_12","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_12","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_indexed_spans","text":"UsageIndexedSpansResponse get_usage_indexed_spans(start_hr) Get hourly usage for indexed spans Get hourly usage for indexed spans.","title":"get_usage_indexed_spans"},{"location":"v1/UsageMeteringApi/#example_13","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_13","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_13","text":"UsageIndexedSpansResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_13","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_13","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_13","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_internet_of_things","text":"UsageIoTResponse get_usage_internet_of_things(start_hr) Get hourly usage for IoT Get hourly usage for IoT.","title":"get_usage_internet_of_things"},{"location":"v1/UsageMeteringApi/#example_14","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_14","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_14","text":"UsageIoTResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_14","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_14","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_14","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_lambda","text":"UsageLambdaResponse get_usage_lambda(start_hr) Get hourly usage for Lambda Get hourly usage for lambda.","title":"get_usage_lambda"},{"location":"v1/UsageMeteringApi/#example_15","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_15","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_15","text":"UsageLambdaResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_15","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_15","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_15","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_logs","text":"UsageLogsResponse get_usage_logs(start_hr) Get hourly usage for Logs Get hourly usage for logs.","title":"get_usage_logs"},{"location":"v1/UsageMeteringApi/#example_16","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_16","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_16","text":"UsageLogsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_16","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_16","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_16","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_logs_by_index","text":"UsageLogsByIndexResponse get_usage_logs_by_index(start_hr) Get hourly usage for Logs by Index Get hourly usage for logs by index.","title":"get_usage_logs_by_index"},{"location":"v1/UsageMeteringApi/#example_17","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) index_name = [ \"index_name_example\", ] # [str] | Comma-separated list of log index names. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr, end_hr=end_hr, index_name=index_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_17","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] index_name [str] Comma-separated list of log index names. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_17","text":"UsageLogsByIndexResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_17","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_17","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_17","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_logs_by_retention","text":"UsageLogsByRetentionResponse get_usage_logs_by_retention(start_hr) Get hourly logs usage by retention Get hourly usage for indexed logs by retention period.","title":"get_usage_logs_by_retention"},{"location":"v1/UsageMeteringApi/#example_18","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_18","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_18","text":"UsageLogsByRetentionResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_18","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_18","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_18","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_network_flows","text":"UsageNetworkFlowsResponse get_usage_network_flows(start_hr) Get hourly usage for Network Flows Get hourly usage for network flows.","title":"get_usage_network_flows"},{"location":"v1/UsageMeteringApi/#example_19","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_19","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_19","text":"UsageNetworkFlowsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_19","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_19","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_19","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_network_hosts","text":"UsageNetworkHostsResponse get_usage_network_hosts(start_hr) Get hourly usage for Network Hosts Get hourly usage for network hosts.","title":"get_usage_network_hosts"},{"location":"v1/UsageMeteringApi/#example_20","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_20","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_20","text":"UsageNetworkHostsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_20","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_20","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_20","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_profiling","text":"UsageProfilingResponse get_usage_profiling(start_hr) Get hourly usage for profiled hosts Get hourly usage for profiled hosts.","title":"get_usage_profiling"},{"location":"v1/UsageMeteringApi/#example_21","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_21","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_21","text":"UsageProfilingResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_21","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_21","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_21","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_rum_sessions","text":"UsageRumSessionsResponse get_usage_rum_sessions(start_hr) Get hourly usage for RUM Sessions Get hourly usage for RUM Sessions.","title":"get_usage_rum_sessions"},{"location":"v1/UsageMeteringApi/#example_22","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) type = \"type_example\" # str | RUM type: `[browser, mobile]`. Defaults to `browser`. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr, end_hr=end_hr, type=type) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_22","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] type str RUM type: `[browser, mobile]`. Defaults to `browser`. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_22","text":"UsageRumSessionsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_22","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_22","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_22","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_snmp","text":"UsageSNMPResponse get_usage_snmp(start_hr) Get hourly usage for SNMP devices Get hourly usage for SNMP devices.","title":"get_usage_snmp"},{"location":"v1/UsageMeteringApi/#example_23","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_23","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_23","text":"UsageSNMPResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_23","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_23","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_23","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_summary","text":"UsageSummaryResponse get_usage_summary(start_month) Get usage across your multi-org account Get usage across your multi-org account. You must have the multi-org feature enabled.","title":"get_usage_summary"},{"location":"v1/UsageMeteringApi/#example_24","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) include_org_details = True # bool | Include usage summaries for each sub-org. (optional) # example passing only required values which don't have defaults set try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month, end_month=end_month, include_org_details=include_org_details) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_24","text":"Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. [optional] include_org_details bool Include usage summaries for each sub-org. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_24","text":"UsageSummaryResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_24","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_24","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_24","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_synthetics","text":"UsageSyntheticsResponse get_usage_synthetics(start_hr) Get hourly usage for Synthetics Checks Get hourly usage for Synthetics checks .","title":"get_usage_synthetics"},{"location":"v1/UsageMeteringApi/#example_25","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_25","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_25","text":"UsageSyntheticsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_25","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_25","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_25","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_synthetics_api","text":"UsageSyntheticsAPIResponse get_usage_synthetics_api(start_hr) Get hourly usage for Synthetics API Checks Get hourly usage for synthetics API checks .","title":"get_usage_synthetics_api"},{"location":"v1/UsageMeteringApi/#example_26","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_26","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_26","text":"UsageSyntheticsAPIResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_26","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_26","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_26","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_synthetics_browser","text":"UsageSyntheticsBrowserResponse get_usage_synthetics_browser(start_hr) Get hourly usage for Synthetics Browser Checks Get hourly usage for synthetics browser checks.","title":"get_usage_synthetics_browser"},{"location":"v1/UsageMeteringApi/#example_27","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_27","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_27","text":"UsageSyntheticsBrowserResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_27","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_27","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_27","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_timeseries","text":"UsageTimeseriesResponse get_usage_timeseries(start_hr) Get hourly usage for custom metrics Get hourly usage for custom metrics .","title":"get_usage_timeseries"},{"location":"v1/UsageMeteringApi/#example_28","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_28","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_28","text":"UsageTimeseriesResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_28","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_28","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_28","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_top_avg_metrics","text":"UsageTopAvgMetricsResponse get_usage_top_avg_metrics() Get top custom metrics by hourly average Get top custom metrics by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed.","title":"get_usage_top_avg_metrics"},{"location":"v1/UsageMeteringApi/#example_29","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = [ \"names_example\", ] # [str] | Comma-separated list of metric names. (optional) limit = 500 # int | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. (optional) if omitted the server will use the default value of 500 # example passing only required values which don't have defaults set # and optional values try: # Get top custom metrics by hourly average api_response = api_instance.get_usage_top_avg_metrics(month=month, day=day, names=names, limit=limit) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_top_avg_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_29","text":"Name Type Description Notes month datetime 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 datetime 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 [str] Comma-separated list of metric names. [optional] limit int Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. [optional] if omitted the server will use the default value of 500","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_29","text":"UsageTopAvgMetricsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_29","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_29","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_29","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_trace","text":"UsageTraceResponse get_usage_trace(start_hr) Get hourly usage for Trace Search Get hourly usage for trace search. Note This endpoint has been renamed to /api/v1/usage/indexed-spans .","title":"get_usage_trace"},{"location":"v1/UsageMeteringApi/#example_30","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_30","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_30","text":"UsageTraceResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_30","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_30","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_30","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMetricCategory/","text":"UsageMetricCategory Contains the metric category. Properties Name Type Description Notes value str Contains the metric category. must be one of [\"standard\", \"custom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageMetricCategory"},{"location":"v1/UsageMetricCategory/#usagemetriccategory","text":"Contains the metric category.","title":"UsageMetricCategory"},{"location":"v1/UsageMetricCategory/#properties","text":"Name Type Description Notes value str Contains the metric category. must be one of [\"standard\", \"custom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkFlowsHour/","text":"UsageNetworkFlowsHour Number of netflow events indexed for each hour for a given organization. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_event_count int Contains the number of netflow events indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkFlowsHour"},{"location":"v1/UsageNetworkFlowsHour/#usagenetworkflowshour","text":"Number of netflow events indexed for each hour for a given organization.","title":"UsageNetworkFlowsHour"},{"location":"v1/UsageNetworkFlowsHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_event_count int Contains the number of netflow events indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkFlowsResponse/","text":"UsageNetworkFlowsResponse Response containing the number of netflow events indexed for each hour for a given organization. Properties Name Type Description Notes usage [UsageNetworkFlowsHour] Get hourly usage for Network Flows. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkFlowsResponse"},{"location":"v1/UsageNetworkFlowsResponse/#usagenetworkflowsresponse","text":"Response containing the number of netflow events indexed for each hour for a given organization.","title":"UsageNetworkFlowsResponse"},{"location":"v1/UsageNetworkFlowsResponse/#properties","text":"Name Type Description Notes usage [UsageNetworkFlowsHour] Get hourly usage for Network Flows. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkHostsHour/","text":"UsageNetworkHostsHour Number of active NPM hosts for each hour for a given organization. Properties Name Type Description Notes host_count int Contains the number of active NPM hosts. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkHostsHour"},{"location":"v1/UsageNetworkHostsHour/#usagenetworkhostshour","text":"Number of active NPM hosts for each hour for a given organization.","title":"UsageNetworkHostsHour"},{"location":"v1/UsageNetworkHostsHour/#properties","text":"Name Type Description Notes host_count int Contains the number of active NPM hosts. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkHostsResponse/","text":"UsageNetworkHostsResponse Response containing the number of active NPM hosts for each hour for a given organization. Properties Name Type Description Notes usage [UsageNetworkHostsHour] Get hourly usage for NPM hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkHostsResponse"},{"location":"v1/UsageNetworkHostsResponse/#usagenetworkhostsresponse","text":"Response containing the number of active NPM hosts for each hour for a given organization.","title":"UsageNetworkHostsResponse"},{"location":"v1/UsageNetworkHostsResponse/#properties","text":"Name Type Description Notes usage [UsageNetworkHostsHour] Get hourly usage for NPM hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageProfilingHour/","text":"UsageProfilingHour The number of profiled hosts for each hour for a given organization. Properties Name Type Description Notes avg_container_agent_count int Get average number of container agents for that hour. [optional] host_count int Contains the total number of profiled hosts reporting during a given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageProfilingHour"},{"location":"v1/UsageProfilingHour/#usageprofilinghour","text":"The number of profiled hosts for each hour for a given organization.","title":"UsageProfilingHour"},{"location":"v1/UsageProfilingHour/#properties","text":"Name Type Description Notes avg_container_agent_count int Get average number of container agents for that hour. [optional] host_count int Contains the total number of profiled hosts reporting during a given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageProfilingResponse/","text":"UsageProfilingResponse Response containing the number of profiled hosts for each hour for a given organization. Properties Name Type Description Notes usage [UsageProfilingHour] Get hourly usage for profiled hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageProfilingResponse"},{"location":"v1/UsageProfilingResponse/#usageprofilingresponse","text":"Response containing the number of profiled hosts for each hour for a given organization.","title":"UsageProfilingResponse"},{"location":"v1/UsageProfilingResponse/#properties","text":"Name Type Description Notes usage [UsageProfilingHour] Get hourly usage for profiled hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageReportsType/","text":"UsageReportsType The type of reports. Properties Name Type Description Notes value str The type of reports. defaults to \"reports\", must be one of [\"reports\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageReportsType"},{"location":"v1/UsageReportsType/#usagereportstype","text":"The type of reports.","title":"UsageReportsType"},{"location":"v1/UsageReportsType/#properties","text":"Name Type Description Notes value str The type of reports. defaults to \"reports\", must be one of [\"reports\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageRumSessionsHour/","text":"UsageRumSessionsHour Number of RUM Sessions recorded for each hour for a given organization. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] session_count int Contains the number of RUM Sessions. [optional] session_count_android int Contains the number of mobile RUM Sessions on Android (data available beginning December 1, 2020). [optional] session_count_ios int Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageRumSessionsHour"},{"location":"v1/UsageRumSessionsHour/#usagerumsessionshour","text":"Number of RUM Sessions recorded for each hour for a given organization.","title":"UsageRumSessionsHour"},{"location":"v1/UsageRumSessionsHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] session_count int Contains the number of RUM Sessions. [optional] session_count_android int Contains the number of mobile RUM Sessions on Android (data available beginning December 1, 2020). [optional] session_count_ios int Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageRumSessionsResponse/","text":"UsageRumSessionsResponse Response containing the number of RUM Sessions for each hour for a given organization. Properties Name Type Description Notes usage [UsageRumSessionsHour] Get hourly usage for RUM Sessions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageRumSessionsResponse"},{"location":"v1/UsageRumSessionsResponse/#usagerumsessionsresponse","text":"Response containing the number of RUM Sessions for each hour for a given organization.","title":"UsageRumSessionsResponse"},{"location":"v1/UsageRumSessionsResponse/#properties","text":"Name Type Description Notes usage [UsageRumSessionsHour] Get hourly usage for RUM Sessions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSNMPHour/","text":"UsageSNMPHour The number of SNMP devices for each hour for a given organization. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] snmp_devices int Contains the number of SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSNMPHour"},{"location":"v1/UsageSNMPHour/#usagesnmphour","text":"The number of SNMP devices for each hour for a given organization.","title":"UsageSNMPHour"},{"location":"v1/UsageSNMPHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] snmp_devices int Contains the number of SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSNMPResponse/","text":"UsageSNMPResponse Response containing the number of SNMP devices for each hour for a given organization. Properties Name Type Description Notes usage [UsageSNMPHour] Get hourly usage for SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSNMPResponse"},{"location":"v1/UsageSNMPResponse/#usagesnmpresponse","text":"Response containing the number of SNMP devices for each hour for a given organization.","title":"UsageSNMPResponse"},{"location":"v1/UsageSNMPResponse/#properties","text":"Name Type Description Notes usage [UsageSNMPHour] Get hourly usage for SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSort/","text":"UsageSort The field to sort by. Properties Name Type Description Notes value str The field to sort by. defaults to \"start_date\", must be one of [\"computed_on\", \"size\", \"start_date\", \"end_date\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSort"},{"location":"v1/UsageSort/#usagesort","text":"The field to sort by.","title":"UsageSort"},{"location":"v1/UsageSort/#properties","text":"Name Type Description Notes value str The field to sort by. defaults to \"start_date\", must be one of [\"computed_on\", \"size\", \"start_date\", \"end_date\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSortDirection/","text":"UsageSortDirection The direction to sort by. Properties Name Type Description Notes value str The direction to sort by. defaults to \"desc\", must be one of [\"desc\", \"asc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSortDirection"},{"location":"v1/UsageSortDirection/#usagesortdirection","text":"The direction to sort by.","title":"UsageSortDirection"},{"location":"v1/UsageSortDirection/#properties","text":"Name Type Description Notes value str The direction to sort by. defaults to \"desc\", must be one of [\"desc\", \"asc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsAttributes/","text":"UsageSpecifiedCustomReportsAttributes The response containing attributes for specified custom reports. Properties Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of specified custom report. [optional] location str A downloadable file for the specified custom reporting file. [optional] size int size [optional] start_date str The starting date of specified custom report. [optional] tags [str] A list of tags to apply to specified custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsAttributes"},{"location":"v1/UsageSpecifiedCustomReportsAttributes/#usagespecifiedcustomreportsattributes","text":"The response containing attributes for specified custom reports.","title":"UsageSpecifiedCustomReportsAttributes"},{"location":"v1/UsageSpecifiedCustomReportsAttributes/#properties","text":"Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of specified custom report. [optional] location str A downloadable file for the specified custom reporting file. [optional] size int size [optional] start_date str The starting date of specified custom report. [optional] tags [str] A list of tags to apply to specified custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsData/","text":"UsageSpecifiedCustomReportsData Response containing date and type for specified custom reports. Properties Name Type Description Notes attributes UsageSpecifiedCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsData"},{"location":"v1/UsageSpecifiedCustomReportsData/#usagespecifiedcustomreportsdata","text":"Response containing date and type for specified custom reports.","title":"UsageSpecifiedCustomReportsData"},{"location":"v1/UsageSpecifiedCustomReportsData/#properties","text":"Name Type Description Notes attributes UsageSpecifiedCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsMeta/","text":"UsageSpecifiedCustomReportsMeta The object containing document metadata. Properties Name Type Description Notes page UsageSpecifiedCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsMeta"},{"location":"v1/UsageSpecifiedCustomReportsMeta/#usagespecifiedcustomreportsmeta","text":"The object containing document metadata.","title":"UsageSpecifiedCustomReportsMeta"},{"location":"v1/UsageSpecifiedCustomReportsMeta/#properties","text":"Name Type Description Notes page UsageSpecifiedCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsPage/","text":"UsageSpecifiedCustomReportsPage The object containing page total count for specified ID. Properties Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsPage"},{"location":"v1/UsageSpecifiedCustomReportsPage/#usagespecifiedcustomreportspage","text":"The object containing page total count for specified ID.","title":"UsageSpecifiedCustomReportsPage"},{"location":"v1/UsageSpecifiedCustomReportsPage/#properties","text":"Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsResponse/","text":"UsageSpecifiedCustomReportsResponse Returns available specified custom reports. Properties Name Type Description Notes data UsageSpecifiedCustomReportsData [optional] meta UsageSpecifiedCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsResponse"},{"location":"v1/UsageSpecifiedCustomReportsResponse/#usagespecifiedcustomreportsresponse","text":"Returns available specified custom reports.","title":"UsageSpecifiedCustomReportsResponse"},{"location":"v1/UsageSpecifiedCustomReportsResponse/#properties","text":"Name Type Description Notes data UsageSpecifiedCustomReportsData [optional] meta UsageSpecifiedCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSummaryDate/","text":"UsageSummaryDate Response with hourly report of all data billed by Datadog all organizations. Properties Name Type Description Notes agent_host_top99p int 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 int Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. [optional] apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. [optional] azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. [optional] billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] compliance_container_count_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of compliance containers over all hours in the current date for all organizations. [optional] compliance_host_count_sum int Shows the sum of compliance hosts over all hours in the current date for all organizations. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for all organizations. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for all organizations. [optional] date datetime The date for the usage. [optional] fargate_tasks_count_avg int Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. [optional] fargate_tasks_count_hwm int Shows the average of all Fargate tasks over all hours in the current date for all organizations. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. [optional] heroku_host_top99p int 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 int 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 int Shows the sum of all log events indexed over all hours in the current date for all organizations. [optional] infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. [optional] ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] iot_device_sum int Shows the sum of all IoT devices over all hours in the current date for all organizations. [optional] iot_device_top99p int Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. [optional] mobile_rum_session_count_android_sum int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for all organizations. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. [optional] opentelemetry_host_top99p int 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 [UsageSummaryDateOrg] Organizations associated with a user. [optional] profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. [optional] rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations [optional] rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. [optional] synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. [optional] synthetics_check_calls_count_sum int 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 int Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. [optional] twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. [optional] vsphere_host_top99p int Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSummaryDate"},{"location":"v1/UsageSummaryDate/#usagesummarydate","text":"Response with hourly report of all data billed by Datadog all organizations.","title":"UsageSummaryDate"},{"location":"v1/UsageSummaryDate/#properties","text":"Name Type Description Notes agent_host_top99p int 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 int Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. [optional] apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. [optional] azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. [optional] billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] compliance_container_count_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of compliance containers over all hours in the current date for all organizations. [optional] compliance_host_count_sum int Shows the sum of compliance hosts over all hours in the current date for all organizations. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for all organizations. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for all organizations. [optional] date datetime The date for the usage. [optional] fargate_tasks_count_avg int Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. [optional] fargate_tasks_count_hwm int Shows the average of all Fargate tasks over all hours in the current date for all organizations. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. [optional] heroku_host_top99p int 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 int 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 int Shows the sum of all log events indexed over all hours in the current date for all organizations. [optional] infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. [optional] ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] iot_device_sum int Shows the sum of all IoT devices over all hours in the current date for all organizations. [optional] iot_device_top99p int Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. [optional] mobile_rum_session_count_android_sum int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for all organizations. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. [optional] opentelemetry_host_top99p int 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 [UsageSummaryDateOrg] Organizations associated with a user. [optional] profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. [optional] rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations [optional] rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. [optional] synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. [optional] synthetics_check_calls_count_sum int 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 int Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. [optional] twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. [optional] vsphere_host_top99p int Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSummaryDateOrg/","text":"UsageSummaryDateOrg Global hourly report of all data billed by Datadog for a given organization. Properties Name Type Description Notes agent_host_top99p int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. [optional] aws_lambda_func_count int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] azure_app_service_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current date for the given org. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current date for the given org. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for the given org. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for the given org. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for the given org. [optional] fargate_tasks_count_avg int The average task count for Fargate. [optional] fargate_tasks_count_hwm int Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. [optional] heroku_host_top99p int Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. [optional] id str The organization id. [optional] incident_management_monthly_active_users_hwm int 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 int Shows the sum of all log events indexed over all hours in the current date for the given org. [optional] infra_host_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for the given org. [optional] iot_device_top99p_sum int 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 int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. [optional] name str The organization name. [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for the given org. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. [optional] opentelemetry_host_top99p int 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 int Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. [optional] public_id str The organization public id. [optional] rum_session_count_sum int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. [optional] synthetics_browser_check_calls_count_sum int 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 int 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 int 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 int 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 int Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSummaryDateOrg"},{"location":"v1/UsageSummaryDateOrg/#usagesummarydateorg","text":"Global hourly report of all data billed by Datadog for a given organization.","title":"UsageSummaryDateOrg"},{"location":"v1/UsageSummaryDateOrg/#properties","text":"Name Type Description Notes agent_host_top99p int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. [optional] aws_lambda_func_count int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] azure_app_service_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current date for the given org. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current date for the given org. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for the given org. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for the given org. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for the given org. [optional] fargate_tasks_count_avg int The average task count for Fargate. [optional] fargate_tasks_count_hwm int Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. [optional] heroku_host_top99p int Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. [optional] id str The organization id. [optional] incident_management_monthly_active_users_hwm int 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 int Shows the sum of all log events indexed over all hours in the current date for the given org. [optional] infra_host_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for the given org. [optional] iot_device_top99p_sum int 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 int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. [optional] name str The organization name. [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for the given org. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. [optional] opentelemetry_host_top99p int 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 int Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. [optional] public_id str The organization public id. [optional] rum_session_count_sum int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. [optional] synthetics_browser_check_calls_count_sum int 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 int 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 int 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 int 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 int Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSummaryResponse/","text":"UsageSummaryResponse Response with hourly report of all data billed by Datadog all organizations. Properties Name Type Description Notes agent_host_top99p_sum int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. [optional] aws_host_top99p_sum int Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. [optional] azure_app_service_top99p_sum int Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. [optional] azure_host_top99p_sum int Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. [optional] billable_ingested_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current months for all organizations. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current months for all organizations. [optional] container_avg_sum int Shows the average of all distinct containers over all hours in the current months for all organizations. [optional] container_hwm_sum int Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. [optional] custom_ts_sum int Shows the average number of distinct custom metrics over all hours in the current months for all organizations. [optional] end_date datetime Shows the last date of usage in the current months for all organizations. [optional] fargate_tasks_count_avg_sum int Shows the average of all Fargate tasks over all hours in the current months for all organizations. [optional] fargate_tasks_count_hwm_sum int 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 int Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. [optional] heroku_host_top99p_sum int 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 int 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 int Shows the sum of all log events indexed over all hours in the current months for all organizations. [optional] infra_host_top99p_sum int 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 int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current months for all organizations. [optional] iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. [optional] last_updated datetime 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 int 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 int 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 [optional] mobile_rum_session_count_agg_sum int 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 int 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 int 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 int Shows the sum of all Network flows indexed over all hours in the current months for all organizations. [optional] npm_host_top99p_sum int Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. [optional] opentelemetry_host_top99p_sum int 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 int Shows the average number of profiled containers over all hours in the current months for all organizations. [optional] profiling_host_count_top99p_sum int Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. [optional] rehydrated_indexed_events_agg_sum int 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 int 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 int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. [optional] start_date datetime Shows the first date of usage in the current months for all organizations. [optional] synthetics_browser_check_calls_count_agg_sum int 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 int 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 int 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 int Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. [optional] usage [UsageSummaryDate] An array of objects regarding hourly usage. [optional] vsphere_host_top99p_sum int Shows the 99th percentile of all vSphere hosts over all hours in the current months for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSummaryResponse"},{"location":"v1/UsageSummaryResponse/#usagesummaryresponse","text":"Response with hourly report of all data billed by Datadog all organizations.","title":"UsageSummaryResponse"},{"location":"v1/UsageSummaryResponse/#properties","text":"Name Type Description Notes agent_host_top99p_sum int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. [optional] aws_host_top99p_sum int Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. [optional] azure_app_service_top99p_sum int Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. [optional] azure_host_top99p_sum int Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. [optional] billable_ingested_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current months for all organizations. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current months for all organizations. [optional] container_avg_sum int Shows the average of all distinct containers over all hours in the current months for all organizations. [optional] container_hwm_sum int Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. [optional] custom_ts_sum int Shows the average number of distinct custom metrics over all hours in the current months for all organizations. [optional] end_date datetime Shows the last date of usage in the current months for all organizations. [optional] fargate_tasks_count_avg_sum int Shows the average of all Fargate tasks over all hours in the current months for all organizations. [optional] fargate_tasks_count_hwm_sum int 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 int Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. [optional] heroku_host_top99p_sum int 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 int 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 int Shows the sum of all log events indexed over all hours in the current months for all organizations. [optional] infra_host_top99p_sum int 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 int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current months for all organizations. [optional] iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. [optional] last_updated datetime 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 int 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 int 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 [optional] mobile_rum_session_count_agg_sum int 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 int 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 int 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 int Shows the sum of all Network flows indexed over all hours in the current months for all organizations. [optional] npm_host_top99p_sum int Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. [optional] opentelemetry_host_top99p_sum int 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 int Shows the average number of profiled containers over all hours in the current months for all organizations. [optional] profiling_host_count_top99p_sum int Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. [optional] rehydrated_indexed_events_agg_sum int 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 int 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 int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. [optional] start_date datetime Shows the first date of usage in the current months for all organizations. [optional] synthetics_browser_check_calls_count_agg_sum int 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 int 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 int 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 int Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. [optional] usage [UsageSummaryDate] An array of objects regarding hourly usage. [optional] vsphere_host_top99p_sum int Shows the 99th percentile of all vSphere hosts over all hours in the current months for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsAPIHour/","text":"UsageSyntheticsAPIHour Number of Synthetics API tests run for each hour for a given organization. Properties Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsAPIHour"},{"location":"v1/UsageSyntheticsAPIHour/#usagesyntheticsapihour","text":"Number of Synthetics API tests run for each hour for a given organization.","title":"UsageSyntheticsAPIHour"},{"location":"v1/UsageSyntheticsAPIHour/#properties","text":"Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsAPIResponse/","text":"UsageSyntheticsAPIResponse Response containing the number of Synthetics API tests run for each hour for a given organization. Properties Name Type Description Notes usage [UsageSyntheticsAPIHour] Get hourly usage for Synthetics API tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsAPIResponse"},{"location":"v1/UsageSyntheticsAPIResponse/#usagesyntheticsapiresponse","text":"Response containing the number of Synthetics API tests run for each hour for a given organization.","title":"UsageSyntheticsAPIResponse"},{"location":"v1/UsageSyntheticsAPIResponse/#properties","text":"Name Type Description Notes usage [UsageSyntheticsAPIHour] Get hourly usage for Synthetics API tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsBrowserHour/","text":"UsageSyntheticsBrowserHour Number of Synthetics Browser tests run for each hour for a given organization. Properties Name Type Description Notes browser_check_calls_count int Contains the number of Synthetics Browser tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsBrowserHour"},{"location":"v1/UsageSyntheticsBrowserHour/#usagesyntheticsbrowserhour","text":"Number of Synthetics Browser tests run for each hour for a given organization.","title":"UsageSyntheticsBrowserHour"},{"location":"v1/UsageSyntheticsBrowserHour/#properties","text":"Name Type Description Notes browser_check_calls_count int Contains the number of Synthetics Browser tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsBrowserResponse/","text":"UsageSyntheticsBrowserResponse Response containing the number of Synthetics Browser tests run for each hour for a given organization. Properties Name Type Description Notes usage [UsageSyntheticsBrowserHour] Get hourly usage for Synthetics Browser tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsBrowserResponse"},{"location":"v1/UsageSyntheticsBrowserResponse/#usagesyntheticsbrowserresponse","text":"Response containing the number of Synthetics Browser tests run for each hour for a given organization.","title":"UsageSyntheticsBrowserResponse"},{"location":"v1/UsageSyntheticsBrowserResponse/#properties","text":"Name Type Description Notes usage [UsageSyntheticsBrowserHour] Get hourly usage for Synthetics Browser tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsHour/","text":"UsageSyntheticsHour The number of synthetics tests run for each hour for a given organization. Properties Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsHour"},{"location":"v1/UsageSyntheticsHour/#usagesyntheticshour","text":"The number of synthetics tests run for each hour for a given organization.","title":"UsageSyntheticsHour"},{"location":"v1/UsageSyntheticsHour/#properties","text":"Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsResponse/","text":"UsageSyntheticsResponse Response containing the number of Synthetics API tests run for each hour for a given organization. Properties Name Type Description Notes usage [UsageSyntheticsHour] Array with the number of hourly Synthetics test run for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsResponse"},{"location":"v1/UsageSyntheticsResponse/#usagesyntheticsresponse","text":"Response containing the number of Synthetics API tests run for each hour for a given organization.","title":"UsageSyntheticsResponse"},{"location":"v1/UsageSyntheticsResponse/#properties","text":"Name Type Description Notes usage [UsageSyntheticsHour] Array with the number of hourly Synthetics test run for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTimeseriesHour/","text":"UsageTimeseriesHour The hourly usage of timeseries. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] num_custom_input_timeseries int Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). [optional] num_custom_output_timeseries int Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). [optional] num_custom_timeseries int Contains the number of non-aggregation custom metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTimeseriesHour"},{"location":"v1/UsageTimeseriesHour/#usagetimeserieshour","text":"The hourly usage of timeseries.","title":"UsageTimeseriesHour"},{"location":"v1/UsageTimeseriesHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] num_custom_input_timeseries int Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). [optional] num_custom_output_timeseries int Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). [optional] num_custom_timeseries int Contains the number of non-aggregation custom metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTimeseriesResponse/","text":"UsageTimeseriesResponse Response containing hourly usage of timeseries. Properties Name Type Description Notes usage [UsageTimeseriesHour] An array of objects regarding hourly usage of timeseries. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTimeseriesResponse"},{"location":"v1/UsageTimeseriesResponse/#usagetimeseriesresponse","text":"Response containing hourly usage of timeseries.","title":"UsageTimeseriesResponse"},{"location":"v1/UsageTimeseriesResponse/#properties","text":"Name Type Description Notes usage [UsageTimeseriesHour] An array of objects regarding hourly usage of timeseries. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTopAvgMetricsHour/","text":"UsageTopAvgMetricsHour Number of hourly recorded custom metrics for a given organization. Properties Name Type Description Notes avg_metric_hour int Average number of timeseries per hour in which the metric occurs. [optional] max_metric_hour int Maximum number of timeseries per hour in which the metric occurs. [optional] metric_category UsageMetricCategory [optional] metric_name str Contains the custom metric name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTopAvgMetricsHour"},{"location":"v1/UsageTopAvgMetricsHour/#usagetopavgmetricshour","text":"Number of hourly recorded custom metrics for a given organization.","title":"UsageTopAvgMetricsHour"},{"location":"v1/UsageTopAvgMetricsHour/#properties","text":"Name Type Description Notes avg_metric_hour int Average number of timeseries per hour in which the metric occurs. [optional] max_metric_hour int Maximum number of timeseries per hour in which the metric occurs. [optional] metric_category UsageMetricCategory [optional] metric_name str Contains the custom metric name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTopAvgMetricsMetadata/","text":"UsageTopAvgMetricsMetadata The object containing document metadata. Properties Name Type Description Notes day bool, date, datetime, dict, float, int, list, str, none_type The day value from the user request that contains the returned usage data. (If day was used the request) [optional] month bool, date, datetime, dict, float, int, list, str, none_type The month value from the user request that contains the returned usage data. (If month was used the request) [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTopAvgMetricsMetadata"},{"location":"v1/UsageTopAvgMetricsMetadata/#usagetopavgmetricsmetadata","text":"The object containing document metadata.","title":"UsageTopAvgMetricsMetadata"},{"location":"v1/UsageTopAvgMetricsMetadata/#properties","text":"Name Type Description Notes day bool, date, datetime, dict, float, int, list, str, none_type The day value from the user request that contains the returned usage data. (If day was used the request) [optional] month bool, date, datetime, dict, float, int, list, str, none_type The month value from the user request that contains the returned usage data. (If month was used the request) [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTopAvgMetricsResponse/","text":"UsageTopAvgMetricsResponse Response containing the number of hourly recorded custom metrics for a given organization. Properties Name Type Description Notes metadata UsageTopAvgMetricsMetadata [optional] usage [UsageTopAvgMetricsHour] Number of hourly recorded custom metrics for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTopAvgMetricsResponse"},{"location":"v1/UsageTopAvgMetricsResponse/#usagetopavgmetricsresponse","text":"Response containing the number of hourly recorded custom metrics for a given organization.","title":"UsageTopAvgMetricsResponse"},{"location":"v1/UsageTopAvgMetricsResponse/#properties","text":"Name Type Description Notes metadata UsageTopAvgMetricsMetadata [optional] usage [UsageTopAvgMetricsHour] Number of hourly recorded custom metrics for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTraceHour/","text":"UsageTraceHour The hours of trace usage. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of Indexed Spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTraceHour"},{"location":"v1/UsageTraceHour/#usagetracehour","text":"The hours of trace usage.","title":"UsageTraceHour"},{"location":"v1/UsageTraceHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of Indexed Spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTraceResponse/","text":"UsageTraceResponse A response containing trace usage. Properties Name Type Description Notes usage [UsageTraceHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTraceResponse"},{"location":"v1/UsageTraceResponse/#usagetraceresponse","text":"A response containing trace usage.","title":"UsageTraceResponse"},{"location":"v1/UsageTraceResponse/#properties","text":"Name Type Description Notes usage [UsageTraceHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTracingWithoutLimitsHour/","text":"UsageTracingWithoutLimitsHour Tracing without limits usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTracingWithoutLimitsHour"},{"location":"v1/UsageTracingWithoutLimitsHour/#usagetracingwithoutlimitshour","text":"Tracing without limits usage for a given organization for a given hour.","title":"UsageTracingWithoutLimitsHour"},{"location":"v1/UsageTracingWithoutLimitsHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTracingWithoutLimitsResponse/","text":"UsageTracingWithoutLimitsResponse Response containing the tracing without limits usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageTracingWithoutLimitsHour] Get hourly usage for tracing without limits. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTracingWithoutLimitsResponse"},{"location":"v1/UsageTracingWithoutLimitsResponse/#usagetracingwithoutlimitsresponse","text":"Response containing the tracing without limits usage for each hour for a given organization.","title":"UsageTracingWithoutLimitsResponse"},{"location":"v1/UsageTracingWithoutLimitsResponse/#properties","text":"Name Type Description Notes usage [UsageTracingWithoutLimitsHour] Get hourly usage for tracing without limits. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/User/","text":"User Create, edit, and disable users. Properties Name Type Description Notes access_role AccessRole [optional] disabled bool The new disabled status of the user. [optional] email str The new email of the user. [optional] handle str The user handle, must be a valid email. [optional] icon str Gravatar icon associated to the user. optional name str The name of the user. [optional] verified bool Whether or not the user logged in Datadog at least once. optional [Back to Model list] [Back to API list] [Back to README]","title":"User"},{"location":"v1/User/#user","text":"Create, edit, and disable users.","title":"User"},{"location":"v1/User/#properties","text":"Name Type Description Notes access_role AccessRole [optional] disabled bool The new disabled status of the user. [optional] email str The new email of the user. [optional] handle str The user handle, must be a valid email. [optional] icon str Gravatar icon associated to the user. optional name str The name of the user. [optional] verified bool Whether or not the user logged in Datadog at least once. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UserDisableResponse/","text":"UserDisableResponse Array of user disabled for a given organization. Properties Name Type Description Notes message str Information pertaining to a user disabled for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserDisableResponse"},{"location":"v1/UserDisableResponse/#userdisableresponse","text":"Array of user disabled for a given organization.","title":"UserDisableResponse"},{"location":"v1/UserDisableResponse/#properties","text":"Name Type Description Notes message str Information pertaining to a user disabled for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UserListResponse/","text":"UserListResponse Array of Datadog users for a given organization. Properties Name Type Description Notes users [User] Array of users. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserListResponse"},{"location":"v1/UserListResponse/#userlistresponse","text":"Array of Datadog users for a given organization.","title":"UserListResponse"},{"location":"v1/UserListResponse/#properties","text":"Name Type Description Notes users [User] Array of users. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UserResponse/","text":"UserResponse A Datadog User. Properties Name Type Description Notes user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponse"},{"location":"v1/UserResponse/#userresponse","text":"A Datadog User.","title":"UserResponse"},{"location":"v1/UserResponse/#properties","text":"Name Type Description Notes user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsersApi/","text":"datadog_api_client.v1.UsersApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v1/user Create a user disable_user DELETE /api/v1/user/{user_handle} Disable a user get_user GET /api/v1/user/{user_handle} Get user details list_users GET /api/v1/user List all users update_user PUT /api/v1/user/{user_handle} Update a user create_user UserResponse create_user(body) Create a user Create a user for your organization. Note : Users can only be created with the admin access role if application keys belong to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | User object that needs to be created. # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e) Parameters Name Type Description Notes body User User object that needs to be created. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 User created - 400 Bad Request - 403 Authentication error - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] disable_user UserDisableResponse disable_user(user_handle) Disable a user Delete a user from an organization. Note : This endpoint can only be used with application keys belonging to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The handle of the user. # example passing only required values which don't have defaults set try: # Disable a user api_response = api_instance.disable_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e) Parameters Name Type Description Notes user_handle str The handle of the user. Return type UserDisableResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 User disabled - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_user UserResponse get_user(user_handle) Get user details Get a user's details. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e) Parameters Name Type Description Notes user_handle str The ID of the user. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_users UserListResponse list_users() List all users List all users for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) # example, this endpoint has no required or optional parameters try: # List all users api_response = api_instance.list_users() pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type UserListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_user UserResponse update_user(user_handle, body) Update a user Update a user information. Note : It can only be used with application keys belonging to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | Description of the update. # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_handle, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e) Parameters Name Type Description Notes user_handle str The ID of the user. body User Description of the update. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 User updated - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.UsersApi"},{"location":"v1/UsersApi/#datadog_api_clientv1usersapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v1/user Create a user disable_user DELETE /api/v1/user/{user_handle} Disable a user get_user GET /api/v1/user/{user_handle} Get user details list_users GET /api/v1/user List all users update_user PUT /api/v1/user/{user_handle} Update a user","title":"datadog_api_client.v1.UsersApi"},{"location":"v1/UsersApi/#create_user","text":"UserResponse create_user(body) Create a user Create a user for your organization. Note : Users can only be created with the admin access role if application keys belong to administrators.","title":"create_user"},{"location":"v1/UsersApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | User object that needs to be created. # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters","text":"Name Type Description Notes body User User object that needs to be created.","title":"Parameters"},{"location":"v1/UsersApi/#return-type","text":"UserResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details","text":"Status code Description Response headers 200 User created - 400 Bad Request - 403 Authentication error - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#disable_user","text":"UserDisableResponse disable_user(user_handle) Disable a user Delete a user from an organization. Note : This endpoint can only be used with application keys belonging to administrators.","title":"disable_user"},{"location":"v1/UsersApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The handle of the user. # example passing only required values which don't have defaults set try: # Disable a user api_response = api_instance.disable_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_1","text":"Name Type Description Notes user_handle str The handle of the user.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_1","text":"UserDisableResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_1","text":"Status code Description Response headers 200 User disabled - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#get_user","text":"UserResponse get_user(user_handle) Get user details Get a user's details.","title":"get_user"},{"location":"v1/UsersApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_2","text":"Name Type Description Notes user_handle str The ID of the user.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_2","text":"UserResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_2","text":"Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#list_users","text":"UserListResponse list_users() List all users List all users for your organization.","title":"list_users"},{"location":"v1/UsersApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) # example, this endpoint has no required or optional parameters try: # List all users api_response = api_instance.list_users() pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_3","text":"UserListResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#update_user","text":"UserResponse update_user(user_handle, body) Update a user Update a user information. Note : It can only be used with application keys belonging to administrators.","title":"update_user"},{"location":"v1/UsersApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | Description of the update. # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_handle, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_4","text":"Name Type Description Notes user_handle str The ID of the user. body User Description of the update.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_4","text":"UserResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_4","text":"Status code Description Response headers 200 User updated - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/Widget/","text":"Widget Information about widget. Note : The layout property is required for widgets in dashboards with free layout_type . For the new dashboard layout , the layout property depends on the reflow_type of the dashboard. - If reflow_type is fixed , layout is required. - If reflow_type is auto , layout should not be set. Properties Name Type Description Notes definition WidgetDefinition id int ID of the widget. [optional] layout WidgetLayout [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Widget"},{"location":"v1/Widget/#widget","text":"Information about widget. Note : The layout property is required for widgets in dashboards with free layout_type . For the new dashboard layout , the layout property depends on the reflow_type of the dashboard. - If reflow_type is fixed , layout is required. - If reflow_type is auto , layout should not be set.","title":"Widget"},{"location":"v1/Widget/#properties","text":"Name Type Description Notes definition WidgetDefinition id int ID of the widget. [optional] layout WidgetLayout [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetAggregator/","text":"WidgetAggregator Aggregator used for the request. Properties Name Type Description Notes value str Aggregator used for the request. must be one of [\"avg\", \"last\", \"max\", \"min\", \"sum\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetAggregator"},{"location":"v1/WidgetAggregator/#widgetaggregator","text":"Aggregator used for the request.","title":"WidgetAggregator"},{"location":"v1/WidgetAggregator/#properties","text":"Name Type Description Notes value str Aggregator used for the request. must be one of [\"avg\", \"last\", \"max\", \"min\", \"sum\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetAxis/","text":"WidgetAxis Axis controls for the widget. Properties Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"WidgetAxis"},{"location":"v1/WidgetAxis/#widgetaxis","text":"Axis controls for the widget.","title":"WidgetAxis"},{"location":"v1/WidgetAxis/#properties","text":"Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetChangeType/","text":"WidgetChangeType Show the absolute or the relative change. Properties Name Type Description Notes value str Show the absolute or the relative change. must be one of [\"absolute\", \"relative\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetChangeType"},{"location":"v1/WidgetChangeType/#widgetchangetype","text":"Show the absolute or the relative change.","title":"WidgetChangeType"},{"location":"v1/WidgetChangeType/#properties","text":"Name Type Description Notes value str Show the absolute or the relative change. must be one of [\"absolute\", \"relative\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetColorPreference/","text":"WidgetColorPreference Which color to use on the widget. Properties Name Type Description Notes value str Which color to use on the widget. must be one of [\"background\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetColorPreference"},{"location":"v1/WidgetColorPreference/#widgetcolorpreference","text":"Which color to use on the widget.","title":"WidgetColorPreference"},{"location":"v1/WidgetColorPreference/#properties","text":"Name Type Description Notes value str Which color to use on the widget. must be one of [\"background\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetComparator/","text":"WidgetComparator Comparator to apply. Properties Name Type Description Notes value str Comparator to apply. must be one of [\">\", \">=\", \"<\", \"<=\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetComparator"},{"location":"v1/WidgetComparator/#widgetcomparator","text":"Comparator to apply.","title":"WidgetComparator"},{"location":"v1/WidgetComparator/#properties","text":"Name Type Description Notes value str Comparator to apply. must be one of [\">\", \">=\", \"<\", \"<=\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetCompareTo/","text":"WidgetCompareTo Timeframe used for the change comparison. Properties Name Type Description Notes value str Timeframe used for the change comparison. must be one of [\"hour_before\", \"day_before\", \"week_before\", \"month_before\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetCompareTo"},{"location":"v1/WidgetCompareTo/#widgetcompareto","text":"Timeframe used for the change comparison.","title":"WidgetCompareTo"},{"location":"v1/WidgetCompareTo/#properties","text":"Name Type Description Notes value str Timeframe used for the change comparison. must be one of [\"hour_before\", \"day_before\", \"week_before\", \"month_before\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetConditionalFormat/","text":"WidgetConditionalFormat Define a conditional format for the widget. Properties Name Type Description Notes comparator WidgetComparator palette WidgetPalette value float Value for the comparator. custom_bg_color str Color palette to apply to the background, same values available as palette. [optional] custom_fg_color str Color palette to apply to the foreground, same values available as palette. [optional] hide_value bool True hides values. [optional] image_url str Displays an image as the background. [optional] metric str Metric from the request to correlate this conditional format with. [optional] timeframe str Defines the displayed timeframe. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetConditionalFormat"},{"location":"v1/WidgetConditionalFormat/#widgetconditionalformat","text":"Define a conditional format for the widget.","title":"WidgetConditionalFormat"},{"location":"v1/WidgetConditionalFormat/#properties","text":"Name Type Description Notes comparator WidgetComparator palette WidgetPalette value float Value for the comparator. custom_bg_color str Color palette to apply to the background, same values available as palette. [optional] custom_fg_color str Color palette to apply to the foreground, same values available as palette. [optional] hide_value bool True hides values. [optional] image_url str Displays an image as the background. [optional] metric str Metric from the request to correlate this conditional format with. [optional] timeframe str Defines the displayed timeframe. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetCustomLink/","text":"WidgetCustomLink Custom links help you connect a data value to a URL, like a Datadog page or your AWS console. Properties Name Type Description Notes label str The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. link str The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. [Back to Model list] [Back to API list] [Back to README]","title":"WidgetCustomLink"},{"location":"v1/WidgetCustomLink/#widgetcustomlink","text":"Custom links help you connect a data value to a URL, like a Datadog page or your AWS console.","title":"WidgetCustomLink"},{"location":"v1/WidgetCustomLink/#properties","text":"Name Type Description Notes label str The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. link str The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetDefinition/","text":"WidgetDefinition Definition of the widget . Properties Name Type Description Notes time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] unit str Unit to display with the value. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] color str Color of the text. [optional] font_size str Size of the text. [optional] background_color str Background color of the note. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True events [WidgetEvent] List of widget events. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetMonitorSummarySort [optional] color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetServiceSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] autoscale bool Whether to use auto-scaling or not. [optional] custom_unit str Display a unit of your choice on the widget. [optional] color_by_groups [str] List of groups used for colors. [optional] global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] view_mode WidgetViewMode [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] has_search_bar TableWidgetHasSearchBar [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] right_yaxis WidgetAxis [optional] alert_id str ID of the alert to use in the widget. [optional] type ToplistWidgetDefinitionType [optional] viz_type WidgetVizType [optional] requests [ToplistWidgetRequest] List of top list widget requests. [optional] check str Name of the check to use in the widget. [optional] grouping WidgetGrouping [optional] query str Query to filter the monitors with. [optional] text str Text to display. [optional] style HostMapWidgetDefinitionStyle [optional] view GeomapWidgetDefinitionView [optional] layout_type WidgetLayoutType [optional] widgets [Widget] List of widget groups. [optional] url str URL of the image. [optional] content str Content of the note. [optional] view_type str Type of view displayed by the widget. [optional] if omitted the server will use the default value of \"detail\" filters [str] Your environment and primary tag (or * if enabled for your account). [optional] service str APM service. [optional] env str APM environment. [optional] span_name str APM span name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetDefinition"},{"location":"v1/WidgetDefinition/#widgetdefinition","text":"Definition of the widget .","title":"WidgetDefinition"},{"location":"v1/WidgetDefinition/#properties","text":"Name Type Description Notes time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] unit str Unit to display with the value. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] color str Color of the text. [optional] font_size str Size of the text. [optional] background_color str Background color of the note. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True events [WidgetEvent] List of widget events. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetMonitorSummarySort [optional] color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetServiceSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] autoscale bool Whether to use auto-scaling or not. [optional] custom_unit str Display a unit of your choice on the widget. [optional] color_by_groups [str] List of groups used for colors. [optional] global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] view_mode WidgetViewMode [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] has_search_bar TableWidgetHasSearchBar [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] right_yaxis WidgetAxis [optional] alert_id str ID of the alert to use in the widget. [optional] type ToplistWidgetDefinitionType [optional] viz_type WidgetVizType [optional] requests [ToplistWidgetRequest] List of top list widget requests. [optional] check str Name of the check to use in the widget. [optional] grouping WidgetGrouping [optional] query str Query to filter the monitors with. [optional] text str Text to display. [optional] style HostMapWidgetDefinitionStyle [optional] view GeomapWidgetDefinitionView [optional] layout_type WidgetLayoutType [optional] widgets [Widget] List of widget groups. [optional] url str URL of the image. [optional] content str Content of the note. [optional] view_type str Type of view displayed by the widget. [optional] if omitted the server will use the default value of \"detail\" filters [str] Your environment and primary tag (or * if enabled for your account). [optional] service str APM service. [optional] env str APM environment. [optional] span_name str APM span name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetDisplayType/","text":"WidgetDisplayType Type of display to use for the request. Properties Name Type Description Notes value str Type of display to use for the request. must be one of [\"area\", \"bars\", \"line\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetDisplayType"},{"location":"v1/WidgetDisplayType/#widgetdisplaytype","text":"Type of display to use for the request.","title":"WidgetDisplayType"},{"location":"v1/WidgetDisplayType/#properties","text":"Name Type Description Notes value str Type of display to use for the request. must be one of [\"area\", \"bars\", \"line\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetEvent/","text":"WidgetEvent Event overlay control options. See the dedicated Events JSON schema documentation to learn how to build the . Properties Name Type Description Notes q str Query definition. tags_execution str The execution method for multi-value filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetEvent"},{"location":"v1/WidgetEvent/#widgetevent","text":"Event overlay control options. See the dedicated Events JSON schema documentation to learn how to build the .","title":"WidgetEvent"},{"location":"v1/WidgetEvent/#properties","text":"Name Type Description Notes q str Query definition. tags_execution str The execution method for multi-value filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetEventSize/","text":"WidgetEventSize Size to use to display an event. Properties Name Type Description Notes value str Size to use to display an event. must be one of [\"s\", \"l\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetEventSize"},{"location":"v1/WidgetEventSize/#widgeteventsize","text":"Size to use to display an event.","title":"WidgetEventSize"},{"location":"v1/WidgetEventSize/#properties","text":"Name Type Description Notes value str Size to use to display an event. must be one of [\"s\", \"l\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetFieldSort/","text":"WidgetFieldSort Which column and order to sort by Properties Name Type Description Notes column str Facet path for the column order WidgetSort [Back to Model list] [Back to API list] [Back to README]","title":"WidgetFieldSort"},{"location":"v1/WidgetFieldSort/#widgetfieldsort","text":"Which column and order to sort by","title":"WidgetFieldSort"},{"location":"v1/WidgetFieldSort/#properties","text":"Name Type Description Notes column str Facet path for the column order WidgetSort [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetFormula/","text":"WidgetFormula Formula to be used in a widget query. Properties Name Type Description Notes formula str String expression built from queries, formulas, and functions. alias str Expression alias. [optional] limit WidgetFormulaLimit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetFormula"},{"location":"v1/WidgetFormula/#widgetformula","text":"Formula to be used in a widget query.","title":"WidgetFormula"},{"location":"v1/WidgetFormula/#properties","text":"Name Type Description Notes formula str String expression built from queries, formulas, and functions. alias str Expression alias. [optional] limit WidgetFormulaLimit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetFormulaLimit/","text":"WidgetFormulaLimit Options for limiting results returned. Properties Name Type Description Notes count int Number of results to return. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetFormulaLimit"},{"location":"v1/WidgetFormulaLimit/#widgetformulalimit","text":"Options for limiting results returned.","title":"WidgetFormulaLimit"},{"location":"v1/WidgetFormulaLimit/#properties","text":"Name Type Description Notes count int Number of results to return. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetGrouping/","text":"WidgetGrouping The kind of grouping to use. Properties Name Type Description Notes value str The kind of grouping to use. must be one of [\"check\", \"cluster\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetGrouping"},{"location":"v1/WidgetGrouping/#widgetgrouping","text":"The kind of grouping to use.","title":"WidgetGrouping"},{"location":"v1/WidgetGrouping/#properties","text":"Name Type Description Notes value str The kind of grouping to use. must be one of [\"check\", \"cluster\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetHorizontalAlign/","text":"WidgetHorizontalAlign Horizontal alignment. Properties Name Type Description Notes value str Horizontal alignment. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetHorizontalAlign"},{"location":"v1/WidgetHorizontalAlign/#widgethorizontalalign","text":"Horizontal alignment.","title":"WidgetHorizontalAlign"},{"location":"v1/WidgetHorizontalAlign/#properties","text":"Name Type Description Notes value str Horizontal alignment. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetImageSizing/","text":"WidgetImageSizing How to size the image on the widget. The values are based on the image object-fit CSS properties. Note : zoom , fit and center values are deprecated. Properties Name Type Description Notes value str How to size the image on the widget. The values are based on the image `object-fit` CSS properties. Note : `zoom`, `fit` and `center` values are deprecated. must be one of [\"fill\", \"contain\", \"cover\", \"none\", \"scale-down\", \"zoom\", \"fit\", \"center\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetImageSizing"},{"location":"v1/WidgetImageSizing/#widgetimagesizing","text":"How to size the image on the widget. The values are based on the image object-fit CSS properties. Note : zoom , fit and center values are deprecated.","title":"WidgetImageSizing"},{"location":"v1/WidgetImageSizing/#properties","text":"Name Type Description Notes value str How to size the image on the widget. The values are based on the image `object-fit` CSS properties. Note : `zoom`, `fit` and `center` values are deprecated. must be one of [\"fill\", \"contain\", \"cover\", \"none\", \"scale-down\", \"zoom\", \"fit\", \"center\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLayout/","text":"WidgetLayout The layout for a widget on a free or new dashboard layout dashboard. Properties Name Type Description Notes height int The height of the widget. Should be a non-negative integer. width int The width of the widget. Should be a non-negative integer. x int The position of the widget on the x (horizontal) axis. Should be a non-negative integer. y int The position of the widget on the y (vertical) axis. Should be a non-negative integer. is_column_break bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLayout"},{"location":"v1/WidgetLayout/#widgetlayout","text":"The layout for a widget on a free or new dashboard layout dashboard.","title":"WidgetLayout"},{"location":"v1/WidgetLayout/#properties","text":"Name Type Description Notes height int The height of the widget. Should be a non-negative integer. width int The width of the widget. Should be a non-negative integer. x int The position of the widget on the x (horizontal) axis. Should be a non-negative integer. y int The position of the widget on the y (vertical) axis. Should be a non-negative integer. is_column_break bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLayoutType/","text":"WidgetLayoutType Layout type of the group. Properties Name Type Description Notes value str Layout type of the group. defaults to \"ordered\", must be one of [\"ordered\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLayoutType"},{"location":"v1/WidgetLayoutType/#widgetlayouttype","text":"Layout type of the group.","title":"WidgetLayoutType"},{"location":"v1/WidgetLayoutType/#properties","text":"Name Type Description Notes value str Layout type of the group. defaults to \"ordered\", must be one of [\"ordered\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLineType/","text":"WidgetLineType Type of lines displayed. Properties Name Type Description Notes value str Type of lines displayed. must be one of [\"dashed\", \"dotted\", \"solid\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLineType"},{"location":"v1/WidgetLineType/#widgetlinetype","text":"Type of lines displayed.","title":"WidgetLineType"},{"location":"v1/WidgetLineType/#properties","text":"Name Type Description Notes value str Type of lines displayed. must be one of [\"dashed\", \"dotted\", \"solid\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLineWidth/","text":"WidgetLineWidth Width of line displayed. Properties Name Type Description Notes value str Width of line displayed. must be one of [\"normal\", \"thick\", \"thin\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLineWidth"},{"location":"v1/WidgetLineWidth/#widgetlinewidth","text":"Width of line displayed.","title":"WidgetLineWidth"},{"location":"v1/WidgetLineWidth/#properties","text":"Name Type Description Notes value str Width of line displayed. must be one of [\"normal\", \"thick\", \"thin\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLiveSpan/","text":"WidgetLiveSpan The available timeframes depend on the widget you are using. Properties Name Type Description Notes value str The available timeframes depend on the widget you are using. must be one of [\"1m\", \"5m\", \"10m\", \"15m\", \"30m\", \"1h\", \"4h\", \"1d\", \"2d\", \"1w\", \"1mo\", \"3mo\", \"6mo\", \"1y\", \"alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLiveSpan"},{"location":"v1/WidgetLiveSpan/#widgetlivespan","text":"The available timeframes depend on the widget you are using.","title":"WidgetLiveSpan"},{"location":"v1/WidgetLiveSpan/#properties","text":"Name Type Description Notes value str The available timeframes depend on the widget you are using. must be one of [\"1m\", \"5m\", \"10m\", \"15m\", \"30m\", \"1h\", \"4h\", \"1d\", \"2d\", \"1w\", \"1mo\", \"3mo\", \"6mo\", \"1y\", \"alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMargin/","text":"WidgetMargin Size of the margins around the image. Note : small and large values are deprecated. Properties Name Type Description Notes value str Size of the margins around the image. Note : `small` and `large` values are deprecated. must be one of [\"sm\", \"md\", \"lg\", \"small\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMargin"},{"location":"v1/WidgetMargin/#widgetmargin","text":"Size of the margins around the image. Note : small and large values are deprecated.","title":"WidgetMargin"},{"location":"v1/WidgetMargin/#properties","text":"Name Type Description Notes value str Size of the margins around the image. Note : `small` and `large` values are deprecated. must be one of [\"sm\", \"md\", \"lg\", \"small\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMarker/","text":"WidgetMarker Markers allow you to add visual conditional formatting for your graphs. Properties Name Type Description Notes value str Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. display_type str 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 str Label to display over the marker. [optional] time str Timestamp for the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMarker"},{"location":"v1/WidgetMarker/#widgetmarker","text":"Markers allow you to add visual conditional formatting for your graphs.","title":"WidgetMarker"},{"location":"v1/WidgetMarker/#properties","text":"Name Type Description Notes value str Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. display_type str 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 str Label to display over the marker. [optional] time str Timestamp for the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMessageDisplay/","text":"WidgetMessageDisplay Amount of log lines to display Properties Name Type Description Notes value str Amount of log lines to display must be one of [\"inline\", \"expanded-md\", \"expanded-lg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMessageDisplay"},{"location":"v1/WidgetMessageDisplay/#widgetmessagedisplay","text":"Amount of log lines to display","title":"WidgetMessageDisplay"},{"location":"v1/WidgetMessageDisplay/#properties","text":"Name Type Description Notes value str Amount of log lines to display must be one of [\"inline\", \"expanded-md\", \"expanded-lg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMonitorSummaryDisplayFormat/","text":"WidgetMonitorSummaryDisplayFormat What to display on the widget. Properties Name Type Description Notes value str What to display on the widget. must be one of [\"counts\", \"countsAndList\", \"list\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMonitorSummaryDisplayFormat"},{"location":"v1/WidgetMonitorSummaryDisplayFormat/#widgetmonitorsummarydisplayformat","text":"What to display on the widget.","title":"WidgetMonitorSummaryDisplayFormat"},{"location":"v1/WidgetMonitorSummaryDisplayFormat/#properties","text":"Name Type Description Notes value str What to display on the widget. must be one of [\"counts\", \"countsAndList\", \"list\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMonitorSummarySort/","text":"WidgetMonitorSummarySort Widget sorting methods. Properties Name Type Description Notes value str Widget sorting methods. must be one of [\"name\", \"group\", \"status\", \"tags\", \"triggered\", \"group,asc\", \"group,desc\", \"name,asc\", \"name,desc\", \"status,asc\", \"status,desc\", \"tags,asc\", \"tags,desc\", \"triggered,asc\", \"triggered,desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMonitorSummarySort"},{"location":"v1/WidgetMonitorSummarySort/#widgetmonitorsummarysort","text":"Widget sorting methods.","title":"WidgetMonitorSummarySort"},{"location":"v1/WidgetMonitorSummarySort/#properties","text":"Name Type Description Notes value str Widget sorting methods. must be one of [\"name\", \"group\", \"status\", \"tags\", \"triggered\", \"group,asc\", \"group,desc\", \"name,asc\", \"name,desc\", \"status,asc\", \"status,desc\", \"tags,asc\", \"tags,desc\", \"triggered,asc\", \"triggered,desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetNodeType/","text":"WidgetNodeType Which type of node to use in the map. Properties Name Type Description Notes value str Which type of node to use in the map. must be one of [\"host\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetNodeType"},{"location":"v1/WidgetNodeType/#widgetnodetype","text":"Which type of node to use in the map.","title":"WidgetNodeType"},{"location":"v1/WidgetNodeType/#properties","text":"Name Type Description Notes value str Which type of node to use in the map. must be one of [\"host\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetOrderBy/","text":"WidgetOrderBy What to order by. Properties Name Type Description Notes value str What to order by. must be one of [\"change\", \"name\", \"present\", \"past\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetOrderBy"},{"location":"v1/WidgetOrderBy/#widgetorderby","text":"What to order by.","title":"WidgetOrderBy"},{"location":"v1/WidgetOrderBy/#properties","text":"Name Type Description Notes value str What to order by. must be one of [\"change\", \"name\", \"present\", \"past\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetPalette/","text":"WidgetPalette Color palette to apply. Properties Name Type Description Notes value str Color palette to apply. must be one of [\"blue\", \"custom_bg\", \"custom_image\", \"custom_text\", \"gray_on_white\", \"grey\", \"green\", \"orange\", \"red\", \"red_on_white\", \"white_on_gray\", \"white_on_green\", \"green_on_white\", \"white_on_red\", \"white_on_yellow\", \"yellow_on_white\", \"black_on_light_yellow\", \"black_on_light_green\", \"black_on_light_red\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetPalette"},{"location":"v1/WidgetPalette/#widgetpalette","text":"Color palette to apply.","title":"WidgetPalette"},{"location":"v1/WidgetPalette/#properties","text":"Name Type Description Notes value str Color palette to apply. must be one of [\"blue\", \"custom_bg\", \"custom_image\", \"custom_text\", \"gray_on_white\", \"grey\", \"green\", \"orange\", \"red\", \"red_on_white\", \"white_on_gray\", \"white_on_green\", \"green_on_white\", \"white_on_red\", \"white_on_yellow\", \"yellow_on_white\", \"black_on_light_yellow\", \"black_on_light_green\", \"black_on_light_red\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetRequestStyle/","text":"WidgetRequestStyle Define request widget style. Properties Name Type Description Notes line_type WidgetLineType [optional] line_width WidgetLineWidth [optional] palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetRequestStyle"},{"location":"v1/WidgetRequestStyle/#widgetrequeststyle","text":"Define request widget style.","title":"WidgetRequestStyle"},{"location":"v1/WidgetRequestStyle/#properties","text":"Name Type Description Notes line_type WidgetLineType [optional] line_width WidgetLineWidth [optional] palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetServiceSummaryDisplayFormat/","text":"WidgetServiceSummaryDisplayFormat Number of columns to display. Properties Name Type Description Notes value str Number of columns to display. must be one of [\"one_column\", \"two_column\", \"three_column\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetServiceSummaryDisplayFormat"},{"location":"v1/WidgetServiceSummaryDisplayFormat/#widgetservicesummarydisplayformat","text":"Number of columns to display.","title":"WidgetServiceSummaryDisplayFormat"},{"location":"v1/WidgetServiceSummaryDisplayFormat/#properties","text":"Name Type Description Notes value str Number of columns to display. must be one of [\"one_column\", \"two_column\", \"three_column\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetSizeFormat/","text":"WidgetSizeFormat Size of the widget. Properties Name Type Description Notes value str Size of the widget. must be one of [\"small\", \"medium\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetSizeFormat"},{"location":"v1/WidgetSizeFormat/#widgetsizeformat","text":"Size of the widget.","title":"WidgetSizeFormat"},{"location":"v1/WidgetSizeFormat/#properties","text":"Name Type Description Notes value str Size of the widget. must be one of [\"small\", \"medium\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetSort/","text":"WidgetSort Widget sorting methods. Properties Name Type Description Notes value str Widget sorting methods. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetSort"},{"location":"v1/WidgetSort/#widgetsort","text":"Widget sorting methods.","title":"WidgetSort"},{"location":"v1/WidgetSort/#properties","text":"Name Type Description Notes value str Widget sorting methods. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetStyle/","text":"WidgetStyle Widget style definition. Properties Name Type Description Notes palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetStyle"},{"location":"v1/WidgetStyle/#widgetstyle","text":"Widget style definition.","title":"WidgetStyle"},{"location":"v1/WidgetStyle/#properties","text":"Name Type Description Notes palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetSummaryType/","text":"WidgetSummaryType Which summary type should be used. Properties Name Type Description Notes value str Which summary type should be used. must be one of [\"monitors\", \"groups\", \"combined\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetSummaryType"},{"location":"v1/WidgetSummaryType/#widgetsummarytype","text":"Which summary type should be used.","title":"WidgetSummaryType"},{"location":"v1/WidgetSummaryType/#properties","text":"Name Type Description Notes value str Which summary type should be used. must be one of [\"monitors\", \"groups\", \"combined\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTextAlign/","text":"WidgetTextAlign How to align the text on the widget. Properties Name Type Description Notes value str How to align the text on the widget. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTextAlign"},{"location":"v1/WidgetTextAlign/#widgettextalign","text":"How to align the text on the widget.","title":"WidgetTextAlign"},{"location":"v1/WidgetTextAlign/#properties","text":"Name Type Description Notes value str How to align the text on the widget. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTickEdge/","text":"WidgetTickEdge Define how you want to align the text on the widget. Properties Name Type Description Notes value str Define how you want to align the text on the widget. must be one of [\"bottom\", \"left\", \"right\", \"top\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTickEdge"},{"location":"v1/WidgetTickEdge/#widgettickedge","text":"Define how you want to align the text on the widget.","title":"WidgetTickEdge"},{"location":"v1/WidgetTickEdge/#properties","text":"Name Type Description Notes value str Define how you want to align the text on the widget. must be one of [\"bottom\", \"left\", \"right\", \"top\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTime/","text":"WidgetTime Time setting for the widget. Properties Name Type Description Notes live_span WidgetLiveSpan [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTime"},{"location":"v1/WidgetTime/#widgettime","text":"Time setting for the widget.","title":"WidgetTime"},{"location":"v1/WidgetTime/#properties","text":"Name Type Description Notes live_span WidgetLiveSpan [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTimeWindows/","text":"WidgetTimeWindows Define a time window. Properties Name Type Description Notes value str Define a time window. must be one of [\"7d\", \"30d\", \"90d\", \"week_to_date\", \"previous_week\", \"month_to_date\", \"previous_month\", \"global_time\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTimeWindows"},{"location":"v1/WidgetTimeWindows/#widgettimewindows","text":"Define a time window.","title":"WidgetTimeWindows"},{"location":"v1/WidgetTimeWindows/#properties","text":"Name Type Description Notes value str Define a time window. must be one of [\"7d\", \"30d\", \"90d\", \"week_to_date\", \"previous_week\", \"month_to_date\", \"previous_month\", \"global_time\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetVerticalAlign/","text":"WidgetVerticalAlign Vertical alignment. Properties Name Type Description Notes value str Vertical alignment. must be one of [\"center\", \"top\", \"bottom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetVerticalAlign"},{"location":"v1/WidgetVerticalAlign/#widgetverticalalign","text":"Vertical alignment.","title":"WidgetVerticalAlign"},{"location":"v1/WidgetVerticalAlign/#properties","text":"Name Type Description Notes value str Vertical alignment. must be one of [\"center\", \"top\", \"bottom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetViewMode/","text":"WidgetViewMode Define how you want the SLO to be displayed. Properties Name Type Description Notes value str Define how you want the SLO to be displayed. must be one of [\"overall\", \"component\", \"both\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetViewMode"},{"location":"v1/WidgetViewMode/#widgetviewmode","text":"Define how you want the SLO to be displayed.","title":"WidgetViewMode"},{"location":"v1/WidgetViewMode/#properties","text":"Name Type Description Notes value str Define how you want the SLO to be displayed. must be one of [\"overall\", \"component\", \"both\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetVizType/","text":"WidgetVizType Whether to display the Alert Graph as a timeseries or a top list. Properties Name Type Description Notes value str Whether to display the Alert Graph as a timeseries or a top list. must be one of [\"timeseries\", \"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetVizType"},{"location":"v1/WidgetVizType/#widgetviztype","text":"Whether to display the Alert Graph as a timeseries or a top list.","title":"WidgetVizType"},{"location":"v1/WidgetVizType/#properties","text":"Name Type Description Notes value str Whether to display the Alert Graph as a timeseries or a top list. must be one of [\"timeseries\", \"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/","text":"datadog-api-client.v2 Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/ Requirements. Python >= 3.6 Installation & Usage pip install If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v2 Setuptools Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v2 Getting Started Please follow the installation procedure and then run the following: import time import datadog_api_client.v2 from pprint import pprint from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.model.api_error_response import APIErrorResponse from datadog_api_client.v2.model.dashboard_list_add_items_request import DashboardListAddItemsRequest from datadog_api_client.v2.model.dashboard_list_add_items_response import DashboardListAddItemsResponse from datadog_api_client.v2.model.dashboard_list_delete_items_request import DashboardListDeleteItemsRequest from datadog_api_client.v2.model.dashboard_list_delete_items_response import DashboardListDeleteItemsResponse from datadog_api_client.v2.model.dashboard_list_items import DashboardListItems from datadog_api_client.v2.model.dashboard_list_update_items_request import DashboardListUpdateItemsRequest from datadog_api_client.v2.model.dashboard_list_update_items_response import DashboardListUpdateItemsResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v2.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except datadog_api_client.v2.ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e) Documentation for API Endpoints All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description DashboardListsApi create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List DashboardListsApi delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list DashboardListsApi get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List DashboardListsApi update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list IncidentServicesApi create_incident_service POST /api/v2/services Create a new incident service IncidentServicesApi delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service IncidentServicesApi get_incident_service GET /api/v2/services/{service_id} Get details of an incident service IncidentServicesApi list_incident_services GET /api/v2/services Get a list of all incident services IncidentServicesApi update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service IncidentTeamsApi create_incident_team POST /api/v2/teams Create a new incident team IncidentTeamsApi delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team IncidentTeamsApi get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team IncidentTeamsApi list_incident_teams GET /api/v2/teams Get a list of all incident teams IncidentTeamsApi update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team IncidentsApi create_incident POST /api/v2/incidents Create an incident IncidentsApi delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident IncidentsApi get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident IncidentsApi list_incidents GET /api/v2/incidents Get a list of incidents IncidentsApi update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident KeyManagementApi create_api_key POST /api/v2/api_keys Create an API key KeyManagementApi create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user KeyManagementApi delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key KeyManagementApi delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key KeyManagementApi delete_current_user_application_key DELETE /api/v2/current_user/application_keys/{app_key_id} Delete an application key owned by current user KeyManagementApi get_api_key GET /api/v2/api_keys/{api_key_id} Get API key KeyManagementApi get_current_user_application_key GET /api/v2/current_user/application_keys/{app_key_id} Get one application key owned by current user KeyManagementApi list_api_keys GET /api/v2/api_keys Get all API keys KeyManagementApi list_application_keys GET /api/v2/application_keys Get all application keys KeyManagementApi list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user KeyManagementApi update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key KeyManagementApi update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key KeyManagementApi update_current_user_application_key PATCH /api/v2/current_user/application_keys/{app_key_id} Edit an application key owned by current user LogsApi aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events LogsApi list_logs POST /api/v2/logs/events/search Search logs LogsApi list_logs_get GET /api/v2/logs/events Get a list of logs LogsArchivesApi add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive LogsArchivesApi create_logs_archive POST /api/v2/logs/config/archives Create an archive LogsArchivesApi delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive LogsArchivesApi get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive LogsArchivesApi get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order LogsArchivesApi list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive LogsArchivesApi list_logs_archives GET /api/v2/logs/config/archives Get all archives LogsArchivesApi remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive LogsArchivesApi update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive LogsArchivesApi update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order LogsMetricsApi create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric LogsMetricsApi delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric LogsMetricsApi get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric LogsMetricsApi list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics LogsMetricsApi update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric MetricsApi create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration MetricsApi delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration MetricsApi list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name MetricsApi list_tag_configurations GET /api/v2/metrics List tag configurations MetricsApi list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name MetricsApi list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name MetricsApi update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration ProcessesApi list_processes GET /api/v2/processes Get all processes RolesApi add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role RolesApi add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role RolesApi create_role POST /api/v2/roles Create role RolesApi delete_role DELETE /api/v2/roles/{role_id} Delete role RolesApi get_role GET /api/v2/roles/{role_id} Get a role RolesApi list_permissions GET /api/v2/permissions List permissions RolesApi list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role RolesApi list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role RolesApi list_roles GET /api/v2/roles List roles RolesApi remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission RolesApi remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role RolesApi update_role PATCH /api/v2/roles/{role_id} Update a role SecurityMonitoringApi create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule SecurityMonitoringApi delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule SecurityMonitoringApi get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details SecurityMonitoringApi list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules SecurityMonitoringApi list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals SecurityMonitoringApi search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals SecurityMonitoringApi update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule UsersApi create_user POST /api/v2/users Create a user UsersApi disable_user DELETE /api/v2/users/{user_id} Disable a user UsersApi get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation UsersApi get_user GET /api/v2/users/{user_id} Get user details UsersApi list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization UsersApi list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions UsersApi list_users GET /api/v2/users List all users UsersApi send_invitations POST /api/v2/user_invitations Send invitation emails UsersApi update_user PATCH /api/v2/users/{user_id} Update a user Documentation For Models APIErrorResponse APIKeyCreateAttributes APIKeyCreateData APIKeyCreateRequest APIKeyRelationships APIKeyResponse APIKeyResponseIncludedItem APIKeyUpdateAttributes APIKeyUpdateData APIKeyUpdateRequest APIKeysResponse APIKeysSort APIKeysType ApplicationKeyCreateAttributes ApplicationKeyCreateData ApplicationKeyCreateRequest ApplicationKeyRelationships ApplicationKeyResponse ApplicationKeyResponseIncludedItem ApplicationKeyUpdateAttributes ApplicationKeyUpdateData ApplicationKeyUpdateRequest ApplicationKeysSort ApplicationKeysType Creator DashboardListAddItemsRequest DashboardListAddItemsResponse DashboardListDeleteItemsRequest DashboardListDeleteItemsResponse DashboardListItem DashboardListItemRequest DashboardListItemResponse DashboardListItems DashboardListUpdateItemsRequest DashboardListUpdateItemsResponse DashboardType FullAPIKey FullAPIKeyAttributes FullApplicationKey FullApplicationKeyAttributes IncidentCreateAttributes IncidentCreateData IncidentCreateRelationships IncidentCreateRequest IncidentFieldAttributes IncidentFieldAttributesMultipleValue IncidentFieldAttributesSingleValue IncidentFieldAttributesSingleValueType IncidentFieldAttributesValueType IncidentIntegrationMetadataType IncidentPostmortemType IncidentRelatedObject IncidentResponse IncidentResponseAttributes IncidentResponseData IncidentResponseIncludedItem IncidentResponseRelationships IncidentServiceCreateAttributes IncidentServiceCreateData IncidentServiceCreateRequest IncidentServiceIncludedItems IncidentServiceRelationships IncidentServiceResponse IncidentServiceResponseAttributes IncidentServiceResponseData IncidentServiceType IncidentServiceUpdateAttributes IncidentServiceUpdateData IncidentServiceUpdateRequest IncidentServicesResponse IncidentServicesResponseMeta IncidentServicesResponseMetaPagination IncidentTeamCreateAttributes IncidentTeamCreateData IncidentTeamCreateRequest IncidentTeamIncludedItems IncidentTeamRelationships IncidentTeamResponse IncidentTeamResponseAttributes IncidentTeamResponseData IncidentTeamType IncidentTeamUpdateAttributes IncidentTeamUpdateData IncidentTeamUpdateRequest IncidentTeamsResponse IncidentTimelineCellCreateAttributes IncidentTimelineCellMarkdownContentType IncidentTimelineCellMarkdownCreateAttributes IncidentTimelineCellMarkdownCreateAttributesContent IncidentType IncidentUpdateAttributes IncidentUpdateData IncidentUpdateRelationships IncidentUpdateRequest IncidentsResponse ListApplicationKeysResponse Log LogAttributes LogType LogsAggregateBucket LogsAggregateBucketValue LogsAggregateBucketValueTimeseries LogsAggregateBucketValueTimeseriesPoint LogsAggregateRequest LogsAggregateRequestPage LogsAggregateResponse LogsAggregateResponseData LogsAggregateResponseStatus LogsAggregateSort LogsAggregateSortType LogsAggregationFunction LogsArchive LogsArchiveAttributes LogsArchiveCreateRequest LogsArchiveCreateRequestAttributes LogsArchiveCreateRequestDefinition LogsArchiveCreateRequestDestination LogsArchiveDefinition LogsArchiveDestination LogsArchiveDestinationAzure LogsArchiveDestinationAzureType LogsArchiveDestinationGCS LogsArchiveDestinationGCSType LogsArchiveDestinationS3 LogsArchiveDestinationS3Type LogsArchiveIntegrationAzure LogsArchiveIntegrationGCS LogsArchiveIntegrationS3 LogsArchiveOrder LogsArchiveOrderAttributes LogsArchiveOrderDefinition LogsArchiveOrderDefinitionType LogsArchiveState LogsArchives LogsCompute LogsComputeType LogsGroupBy LogsGroupByHistogram LogsGroupByMissing LogsGroupByTotal LogsListRequest LogsListRequestPage LogsListResponse LogsListResponseLinks LogsMetricCompute LogsMetricComputeAggregationType LogsMetricCreateAttributes LogsMetricCreateData LogsMetricCreateRequest LogsMetricFilter LogsMetricGroupBy LogsMetricResponse LogsMetricResponseAttributes LogsMetricResponseCompute LogsMetricResponseComputeAggregationType LogsMetricResponseData LogsMetricResponseFilter LogsMetricResponseGroupBy LogsMetricType LogsMetricUpdateAttributes LogsMetricUpdateData LogsMetricUpdateRequest LogsMetricsResponse LogsQueryFilter LogsQueryOptions LogsResponseMetadata LogsResponseMetadataPage LogsSort LogsSortOrder LogsWarning Metric MetricAllTags MetricAllTagsAttributes MetricAllTagsResponse MetricDistinctVolume MetricDistinctVolumeAttributes MetricDistinctVolumeType MetricIngestedIndexedVolume MetricIngestedIndexedVolumeAttributes MetricIngestedIndexedVolumeType MetricTagConfiguration MetricTagConfigurationAttributes MetricTagConfigurationCreateAttributes MetricTagConfigurationCreateData MetricTagConfigurationCreateRequest MetricTagConfigurationMetricTypes MetricTagConfigurationResponse MetricTagConfigurationType MetricTagConfigurationUpdateAttributes MetricTagConfigurationUpdateData MetricTagConfigurationUpdateRequest MetricType MetricVolumes MetricVolumesResponse MetricsAndMetricTagConfigurations MetricsAndMetricTagConfigurationsResponse Organization OrganizationAttributes OrganizationsType Pagination PartialAPIKey PartialAPIKeyAttributes PartialApplicationKey PartialApplicationKeyAttributes Permission PermissionAttributes PermissionsResponse PermissionsType ProcessSummariesMeta ProcessSummariesMetaPage ProcessSummariesResponse ProcessSummary ProcessSummaryAttributes ProcessSummaryType QuerySortOrder RelationshipToIncidentIntegrationMetadataData RelationshipToIncidentIntegrationMetadatas RelationshipToIncidentPostmortem RelationshipToIncidentPostmortemData RelationshipToOrganization RelationshipToOrganizationData RelationshipToOrganizations RelationshipToPermission RelationshipToPermissionData RelationshipToPermissions RelationshipToRole RelationshipToRoleData RelationshipToRoles RelationshipToUser RelationshipToUserData RelationshipToUsers ResponseMetaAttributes Role RoleAttributes RoleCreateAttributes RoleCreateData RoleCreateRequest RoleCreateResponse RoleCreateResponseData RoleRelationships RoleResponse RoleResponseRelationships RoleUpdateAttributes RoleUpdateData RoleUpdateRequest RoleUpdateResponse RoleUpdateResponseData RolesResponse RolesSort RolesType SecurityMonitoringFilter SecurityMonitoringFilterAction SecurityMonitoringListRulesResponse SecurityMonitoringRuleCase SecurityMonitoringRuleCaseCreate SecurityMonitoringRuleCreatePayload SecurityMonitoringRuleDetectionMethod SecurityMonitoringRuleEvaluationWindow SecurityMonitoringRuleKeepAlive SecurityMonitoringRuleMaxSignalDuration SecurityMonitoringRuleNewValueOptions SecurityMonitoringRuleNewValueOptionsForgetAfter SecurityMonitoringRuleNewValueOptionsLearningDuration SecurityMonitoringRuleOptions SecurityMonitoringRuleQuery SecurityMonitoringRuleQueryAggregation SecurityMonitoringRuleQueryCreate SecurityMonitoringRuleResponse SecurityMonitoringRuleSeverity SecurityMonitoringRuleUpdatePayload SecurityMonitoringRuntimeAgentRule SecurityMonitoringSignal SecurityMonitoringSignalAttributes SecurityMonitoringSignalListRequest SecurityMonitoringSignalListRequestFilter SecurityMonitoringSignalListRequestPage SecurityMonitoringSignalType SecurityMonitoringSignalsListResponse SecurityMonitoringSignalsListResponseLinks SecurityMonitoringSignalsListResponseMeta SecurityMonitoringSignalsListResponseMetaPage SecurityMonitoringSignalsSort User UserAttributes UserCreateAttributes UserCreateData UserCreateRequest UserInvitationData UserInvitationDataAttributes UserInvitationRelationships UserInvitationResponse UserInvitationResponseData UserInvitationsRequest UserInvitationsResponse UserInvitationsType UserRelationships UserResponse UserResponseIncludedItem UserResponseRelationships UserUpdateAttributes UserUpdateData UserUpdateRequest UsersResponse UsersType Documentation For Authorization 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 Author support@datadoghq.com Notes for Large OpenAPI documents If the OpenAPI document is large, imports in datadog_api_client.v2.apis and datadog_api_client.v2.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v2.api.default_api import DefaultApi - from datadog_api_client.v2.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v2 from datadog_api_client.v2.apis import * from datadog_api_client.v2.models import *","title":"datadog-api-client.v2"},{"location":"v2/#datadog-api-clientv2","text":"Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/","title":"datadog-api-client.v2"},{"location":"v2/#requirements","text":"Python >= 3.6","title":"Requirements."},{"location":"v2/#installation-usage","text":"","title":"Installation & Usage"},{"location":"v2/#pip-install","text":"If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v2","title":"pip install"},{"location":"v2/#setuptools","text":"Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v2","title":"Setuptools"},{"location":"v2/#getting-started","text":"Please follow the installation procedure and then run the following: import time import datadog_api_client.v2 from pprint import pprint from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.model.api_error_response import APIErrorResponse from datadog_api_client.v2.model.dashboard_list_add_items_request import DashboardListAddItemsRequest from datadog_api_client.v2.model.dashboard_list_add_items_response import DashboardListAddItemsResponse from datadog_api_client.v2.model.dashboard_list_delete_items_request import DashboardListDeleteItemsRequest from datadog_api_client.v2.model.dashboard_list_delete_items_response import DashboardListDeleteItemsResponse from datadog_api_client.v2.model.dashboard_list_items import DashboardListItems from datadog_api_client.v2.model.dashboard_list_update_items_request import DashboardListUpdateItemsRequest from datadog_api_client.v2.model.dashboard_list_update_items_response import DashboardListUpdateItemsResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v2.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except datadog_api_client.v2.ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e)","title":"Getting Started"},{"location":"v2/#documentation-for-api-endpoints","text":"All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description DashboardListsApi create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List DashboardListsApi delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list DashboardListsApi get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List DashboardListsApi update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list IncidentServicesApi create_incident_service POST /api/v2/services Create a new incident service IncidentServicesApi delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service IncidentServicesApi get_incident_service GET /api/v2/services/{service_id} Get details of an incident service IncidentServicesApi list_incident_services GET /api/v2/services Get a list of all incident services IncidentServicesApi update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service IncidentTeamsApi create_incident_team POST /api/v2/teams Create a new incident team IncidentTeamsApi delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team IncidentTeamsApi get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team IncidentTeamsApi list_incident_teams GET /api/v2/teams Get a list of all incident teams IncidentTeamsApi update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team IncidentsApi create_incident POST /api/v2/incidents Create an incident IncidentsApi delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident IncidentsApi get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident IncidentsApi list_incidents GET /api/v2/incidents Get a list of incidents IncidentsApi update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident KeyManagementApi create_api_key POST /api/v2/api_keys Create an API key KeyManagementApi create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user KeyManagementApi delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key KeyManagementApi delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key KeyManagementApi delete_current_user_application_key DELETE /api/v2/current_user/application_keys/{app_key_id} Delete an application key owned by current user KeyManagementApi get_api_key GET /api/v2/api_keys/{api_key_id} Get API key KeyManagementApi get_current_user_application_key GET /api/v2/current_user/application_keys/{app_key_id} Get one application key owned by current user KeyManagementApi list_api_keys GET /api/v2/api_keys Get all API keys KeyManagementApi list_application_keys GET /api/v2/application_keys Get all application keys KeyManagementApi list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user KeyManagementApi update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key KeyManagementApi update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key KeyManagementApi update_current_user_application_key PATCH /api/v2/current_user/application_keys/{app_key_id} Edit an application key owned by current user LogsApi aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events LogsApi list_logs POST /api/v2/logs/events/search Search logs LogsApi list_logs_get GET /api/v2/logs/events Get a list of logs LogsArchivesApi add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive LogsArchivesApi create_logs_archive POST /api/v2/logs/config/archives Create an archive LogsArchivesApi delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive LogsArchivesApi get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive LogsArchivesApi get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order LogsArchivesApi list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive LogsArchivesApi list_logs_archives GET /api/v2/logs/config/archives Get all archives LogsArchivesApi remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive LogsArchivesApi update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive LogsArchivesApi update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order LogsMetricsApi create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric LogsMetricsApi delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric LogsMetricsApi get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric LogsMetricsApi list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics LogsMetricsApi update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric MetricsApi create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration MetricsApi delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration MetricsApi list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name MetricsApi list_tag_configurations GET /api/v2/metrics List tag configurations MetricsApi list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name MetricsApi list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name MetricsApi update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration ProcessesApi list_processes GET /api/v2/processes Get all processes RolesApi add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role RolesApi add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role RolesApi create_role POST /api/v2/roles Create role RolesApi delete_role DELETE /api/v2/roles/{role_id} Delete role RolesApi get_role GET /api/v2/roles/{role_id} Get a role RolesApi list_permissions GET /api/v2/permissions List permissions RolesApi list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role RolesApi list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role RolesApi list_roles GET /api/v2/roles List roles RolesApi remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission RolesApi remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role RolesApi update_role PATCH /api/v2/roles/{role_id} Update a role SecurityMonitoringApi create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule SecurityMonitoringApi delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule SecurityMonitoringApi get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details SecurityMonitoringApi list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules SecurityMonitoringApi list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals SecurityMonitoringApi search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals SecurityMonitoringApi update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule UsersApi create_user POST /api/v2/users Create a user UsersApi disable_user DELETE /api/v2/users/{user_id} Disable a user UsersApi get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation UsersApi get_user GET /api/v2/users/{user_id} Get user details UsersApi list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization UsersApi list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions UsersApi list_users GET /api/v2/users List all users UsersApi send_invitations POST /api/v2/user_invitations Send invitation emails UsersApi update_user PATCH /api/v2/users/{user_id} Update a user","title":"Documentation for API Endpoints"},{"location":"v2/#documentation-for-models","text":"APIErrorResponse APIKeyCreateAttributes APIKeyCreateData APIKeyCreateRequest APIKeyRelationships APIKeyResponse APIKeyResponseIncludedItem APIKeyUpdateAttributes APIKeyUpdateData APIKeyUpdateRequest APIKeysResponse APIKeysSort APIKeysType ApplicationKeyCreateAttributes ApplicationKeyCreateData ApplicationKeyCreateRequest ApplicationKeyRelationships ApplicationKeyResponse ApplicationKeyResponseIncludedItem ApplicationKeyUpdateAttributes ApplicationKeyUpdateData ApplicationKeyUpdateRequest ApplicationKeysSort ApplicationKeysType Creator DashboardListAddItemsRequest DashboardListAddItemsResponse DashboardListDeleteItemsRequest DashboardListDeleteItemsResponse DashboardListItem DashboardListItemRequest DashboardListItemResponse DashboardListItems DashboardListUpdateItemsRequest DashboardListUpdateItemsResponse DashboardType FullAPIKey FullAPIKeyAttributes FullApplicationKey FullApplicationKeyAttributes IncidentCreateAttributes IncidentCreateData IncidentCreateRelationships IncidentCreateRequest IncidentFieldAttributes IncidentFieldAttributesMultipleValue IncidentFieldAttributesSingleValue IncidentFieldAttributesSingleValueType IncidentFieldAttributesValueType IncidentIntegrationMetadataType IncidentPostmortemType IncidentRelatedObject IncidentResponse IncidentResponseAttributes IncidentResponseData IncidentResponseIncludedItem IncidentResponseRelationships IncidentServiceCreateAttributes IncidentServiceCreateData IncidentServiceCreateRequest IncidentServiceIncludedItems IncidentServiceRelationships IncidentServiceResponse IncidentServiceResponseAttributes IncidentServiceResponseData IncidentServiceType IncidentServiceUpdateAttributes IncidentServiceUpdateData IncidentServiceUpdateRequest IncidentServicesResponse IncidentServicesResponseMeta IncidentServicesResponseMetaPagination IncidentTeamCreateAttributes IncidentTeamCreateData IncidentTeamCreateRequest IncidentTeamIncludedItems IncidentTeamRelationships IncidentTeamResponse IncidentTeamResponseAttributes IncidentTeamResponseData IncidentTeamType IncidentTeamUpdateAttributes IncidentTeamUpdateData IncidentTeamUpdateRequest IncidentTeamsResponse IncidentTimelineCellCreateAttributes IncidentTimelineCellMarkdownContentType IncidentTimelineCellMarkdownCreateAttributes IncidentTimelineCellMarkdownCreateAttributesContent IncidentType IncidentUpdateAttributes IncidentUpdateData IncidentUpdateRelationships IncidentUpdateRequest IncidentsResponse ListApplicationKeysResponse Log LogAttributes LogType LogsAggregateBucket LogsAggregateBucketValue LogsAggregateBucketValueTimeseries LogsAggregateBucketValueTimeseriesPoint LogsAggregateRequest LogsAggregateRequestPage LogsAggregateResponse LogsAggregateResponseData LogsAggregateResponseStatus LogsAggregateSort LogsAggregateSortType LogsAggregationFunction LogsArchive LogsArchiveAttributes LogsArchiveCreateRequest LogsArchiveCreateRequestAttributes LogsArchiveCreateRequestDefinition LogsArchiveCreateRequestDestination LogsArchiveDefinition LogsArchiveDestination LogsArchiveDestinationAzure LogsArchiveDestinationAzureType LogsArchiveDestinationGCS LogsArchiveDestinationGCSType LogsArchiveDestinationS3 LogsArchiveDestinationS3Type LogsArchiveIntegrationAzure LogsArchiveIntegrationGCS LogsArchiveIntegrationS3 LogsArchiveOrder LogsArchiveOrderAttributes LogsArchiveOrderDefinition LogsArchiveOrderDefinitionType LogsArchiveState LogsArchives LogsCompute LogsComputeType LogsGroupBy LogsGroupByHistogram LogsGroupByMissing LogsGroupByTotal LogsListRequest LogsListRequestPage LogsListResponse LogsListResponseLinks LogsMetricCompute LogsMetricComputeAggregationType LogsMetricCreateAttributes LogsMetricCreateData LogsMetricCreateRequest LogsMetricFilter LogsMetricGroupBy LogsMetricResponse LogsMetricResponseAttributes LogsMetricResponseCompute LogsMetricResponseComputeAggregationType LogsMetricResponseData LogsMetricResponseFilter LogsMetricResponseGroupBy LogsMetricType LogsMetricUpdateAttributes LogsMetricUpdateData LogsMetricUpdateRequest LogsMetricsResponse LogsQueryFilter LogsQueryOptions LogsResponseMetadata LogsResponseMetadataPage LogsSort LogsSortOrder LogsWarning Metric MetricAllTags MetricAllTagsAttributes MetricAllTagsResponse MetricDistinctVolume MetricDistinctVolumeAttributes MetricDistinctVolumeType MetricIngestedIndexedVolume MetricIngestedIndexedVolumeAttributes MetricIngestedIndexedVolumeType MetricTagConfiguration MetricTagConfigurationAttributes MetricTagConfigurationCreateAttributes MetricTagConfigurationCreateData MetricTagConfigurationCreateRequest MetricTagConfigurationMetricTypes MetricTagConfigurationResponse MetricTagConfigurationType MetricTagConfigurationUpdateAttributes MetricTagConfigurationUpdateData MetricTagConfigurationUpdateRequest MetricType MetricVolumes MetricVolumesResponse MetricsAndMetricTagConfigurations MetricsAndMetricTagConfigurationsResponse Organization OrganizationAttributes OrganizationsType Pagination PartialAPIKey PartialAPIKeyAttributes PartialApplicationKey PartialApplicationKeyAttributes Permission PermissionAttributes PermissionsResponse PermissionsType ProcessSummariesMeta ProcessSummariesMetaPage ProcessSummariesResponse ProcessSummary ProcessSummaryAttributes ProcessSummaryType QuerySortOrder RelationshipToIncidentIntegrationMetadataData RelationshipToIncidentIntegrationMetadatas RelationshipToIncidentPostmortem RelationshipToIncidentPostmortemData RelationshipToOrganization RelationshipToOrganizationData RelationshipToOrganizations RelationshipToPermission RelationshipToPermissionData RelationshipToPermissions RelationshipToRole RelationshipToRoleData RelationshipToRoles RelationshipToUser RelationshipToUserData RelationshipToUsers ResponseMetaAttributes Role RoleAttributes RoleCreateAttributes RoleCreateData RoleCreateRequest RoleCreateResponse RoleCreateResponseData RoleRelationships RoleResponse RoleResponseRelationships RoleUpdateAttributes RoleUpdateData RoleUpdateRequest RoleUpdateResponse RoleUpdateResponseData RolesResponse RolesSort RolesType SecurityMonitoringFilter SecurityMonitoringFilterAction SecurityMonitoringListRulesResponse SecurityMonitoringRuleCase SecurityMonitoringRuleCaseCreate SecurityMonitoringRuleCreatePayload SecurityMonitoringRuleDetectionMethod SecurityMonitoringRuleEvaluationWindow SecurityMonitoringRuleKeepAlive SecurityMonitoringRuleMaxSignalDuration SecurityMonitoringRuleNewValueOptions SecurityMonitoringRuleNewValueOptionsForgetAfter SecurityMonitoringRuleNewValueOptionsLearningDuration SecurityMonitoringRuleOptions SecurityMonitoringRuleQuery SecurityMonitoringRuleQueryAggregation SecurityMonitoringRuleQueryCreate SecurityMonitoringRuleResponse SecurityMonitoringRuleSeverity SecurityMonitoringRuleUpdatePayload SecurityMonitoringRuntimeAgentRule SecurityMonitoringSignal SecurityMonitoringSignalAttributes SecurityMonitoringSignalListRequest SecurityMonitoringSignalListRequestFilter SecurityMonitoringSignalListRequestPage SecurityMonitoringSignalType SecurityMonitoringSignalsListResponse SecurityMonitoringSignalsListResponseLinks SecurityMonitoringSignalsListResponseMeta SecurityMonitoringSignalsListResponseMetaPage SecurityMonitoringSignalsSort User UserAttributes UserCreateAttributes UserCreateData UserCreateRequest UserInvitationData UserInvitationDataAttributes UserInvitationRelationships UserInvitationResponse UserInvitationResponseData UserInvitationsRequest UserInvitationsResponse UserInvitationsType UserRelationships UserResponse UserResponseIncludedItem UserResponseRelationships UserUpdateAttributes UserUpdateData UserUpdateRequest UsersResponse UsersType","title":"Documentation For Models"},{"location":"v2/#documentation-for-authorization","text":"","title":"Documentation For Authorization"},{"location":"v2/#apikeyauth","text":"Type : API key API key parameter name : DD-API-KEY Location : HTTP header","title":"apiKeyAuth"},{"location":"v2/#appkeyauth","text":"Type : API key API key parameter name : DD-APPLICATION-KEY Location : HTTP header","title":"appKeyAuth"},{"location":"v2/#author","text":"support@datadoghq.com","title":"Author"},{"location":"v2/#notes-for-large-openapi-documents","text":"If the OpenAPI document is large, imports in datadog_api_client.v2.apis and datadog_api_client.v2.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v2.api.default_api import DefaultApi - from datadog_api_client.v2.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v2 from datadog_api_client.v2.apis import * from datadog_api_client.v2.models import *","title":"Notes for Large OpenAPI documents"},{"location":"v2/APIErrorResponse/","text":"APIErrorResponse API error response. Properties Name Type Description Notes errors [str] A list of errors. [Back to Model list] [Back to API list] [Back to README]","title":"APIErrorResponse"},{"location":"v2/APIErrorResponse/#apierrorresponse","text":"API error response.","title":"APIErrorResponse"},{"location":"v2/APIErrorResponse/#properties","text":"Name Type Description Notes errors [str] A list of errors. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyCreateAttributes/","text":"APIKeyCreateAttributes Attributes used to create an API Key. Properties Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyCreateAttributes"},{"location":"v2/APIKeyCreateAttributes/#apikeycreateattributes","text":"Attributes used to create an API Key.","title":"APIKeyCreateAttributes"},{"location":"v2/APIKeyCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyCreateData/","text":"APIKeyCreateData Object used to create an API key. Properties Name Type Description Notes attributes APIKeyCreateAttributes type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyCreateData"},{"location":"v2/APIKeyCreateData/#apikeycreatedata","text":"Object used to create an API key.","title":"APIKeyCreateData"},{"location":"v2/APIKeyCreateData/#properties","text":"Name Type Description Notes attributes APIKeyCreateAttributes type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyCreateRequest/","text":"APIKeyCreateRequest Request used to create an API key. Properties Name Type Description Notes data APIKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyCreateRequest"},{"location":"v2/APIKeyCreateRequest/#apikeycreaterequest","text":"Request used to create an API key.","title":"APIKeyCreateRequest"},{"location":"v2/APIKeyCreateRequest/#properties","text":"Name Type Description Notes data APIKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyRelationships/","text":"APIKeyRelationships Resources related to the API key. Properties Name Type Description Notes created_by RelationshipToUser [optional] modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyRelationships"},{"location":"v2/APIKeyRelationships/#apikeyrelationships","text":"Resources related to the API key.","title":"APIKeyRelationships"},{"location":"v2/APIKeyRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyResponse/","text":"APIKeyResponse Response for retrieving an API key. Properties Name Type Description Notes data FullAPIKey [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyResponse"},{"location":"v2/APIKeyResponse/#apikeyresponse","text":"Response for retrieving an API key.","title":"APIKeyResponse"},{"location":"v2/APIKeyResponse/#properties","text":"Name Type Description Notes data FullAPIKey [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyResponseIncludedItem/","text":"APIKeyResponseIncludedItem An object related to an API key. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyResponseIncludedItem"},{"location":"v2/APIKeyResponseIncludedItem/#apikeyresponseincludeditem","text":"An object related to an API key.","title":"APIKeyResponseIncludedItem"},{"location":"v2/APIKeyResponseIncludedItem/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyUpdateAttributes/","text":"APIKeyUpdateAttributes Attributes used to update an API Key. Properties Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyUpdateAttributes"},{"location":"v2/APIKeyUpdateAttributes/#apikeyupdateattributes","text":"Attributes used to update an API Key.","title":"APIKeyUpdateAttributes"},{"location":"v2/APIKeyUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyUpdateData/","text":"APIKeyUpdateData Object used to update an API key. Properties Name Type Description Notes attributes APIKeyUpdateAttributes id str ID of the API key. type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyUpdateData"},{"location":"v2/APIKeyUpdateData/#apikeyupdatedata","text":"Object used to update an API key.","title":"APIKeyUpdateData"},{"location":"v2/APIKeyUpdateData/#properties","text":"Name Type Description Notes attributes APIKeyUpdateAttributes id str ID of the API key. type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyUpdateRequest/","text":"APIKeyUpdateRequest Request used to update an API key. Properties Name Type Description Notes data APIKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyUpdateRequest"},{"location":"v2/APIKeyUpdateRequest/#apikeyupdaterequest","text":"Request used to update an API key.","title":"APIKeyUpdateRequest"},{"location":"v2/APIKeyUpdateRequest/#properties","text":"Name Type Description Notes data APIKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeysResponse/","text":"APIKeysResponse Response for a list of API keys. Properties Name Type Description Notes data [PartialAPIKey] Array of API keys. [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeysResponse"},{"location":"v2/APIKeysResponse/#apikeysresponse","text":"Response for a list of API keys.","title":"APIKeysResponse"},{"location":"v2/APIKeysResponse/#properties","text":"Name Type Description Notes data [PartialAPIKey] Array of API keys. [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeysSort/","text":"APIKeysSort Sorting options Properties Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"modified_at\", \"-modified_at\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeysSort"},{"location":"v2/APIKeysSort/#apikeyssort","text":"Sorting options","title":"APIKeysSort"},{"location":"v2/APIKeysSort/#properties","text":"Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"modified_at\", \"-modified_at\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeysType/","text":"APIKeysType API Keys resource type. Properties Name Type Description Notes value str API Keys resource type. defaults to \"api_keys\", must be one of [\"api_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeysType"},{"location":"v2/APIKeysType/#apikeystype","text":"API Keys resource type.","title":"APIKeysType"},{"location":"v2/APIKeysType/#properties","text":"Name Type Description Notes value str API Keys resource type. defaults to \"api_keys\", must be one of [\"api_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyCreateAttributes/","text":"ApplicationKeyCreateAttributes Attributes used to create an application Key. Properties Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyCreateAttributes"},{"location":"v2/ApplicationKeyCreateAttributes/#applicationkeycreateattributes","text":"Attributes used to create an application Key.","title":"ApplicationKeyCreateAttributes"},{"location":"v2/ApplicationKeyCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyCreateData/","text":"ApplicationKeyCreateData Object used to create an application key. Properties Name Type Description Notes attributes ApplicationKeyCreateAttributes type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyCreateData"},{"location":"v2/ApplicationKeyCreateData/#applicationkeycreatedata","text":"Object used to create an application key.","title":"ApplicationKeyCreateData"},{"location":"v2/ApplicationKeyCreateData/#properties","text":"Name Type Description Notes attributes ApplicationKeyCreateAttributes type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyCreateRequest/","text":"ApplicationKeyCreateRequest Request used to create an application key. Properties Name Type Description Notes data ApplicationKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyCreateRequest"},{"location":"v2/ApplicationKeyCreateRequest/#applicationkeycreaterequest","text":"Request used to create an application key.","title":"ApplicationKeyCreateRequest"},{"location":"v2/ApplicationKeyCreateRequest/#properties","text":"Name Type Description Notes data ApplicationKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyRelationships/","text":"ApplicationKeyRelationships Resources related to the application key. Properties Name Type Description Notes created_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyRelationships"},{"location":"v2/ApplicationKeyRelationships/#applicationkeyrelationships","text":"Resources related to the application key.","title":"ApplicationKeyRelationships"},{"location":"v2/ApplicationKeyRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyResponse/","text":"ApplicationKeyResponse Response for retrieving an application key. Properties Name Type Description Notes data FullApplicationKey [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyResponse"},{"location":"v2/ApplicationKeyResponse/#applicationkeyresponse","text":"Response for retrieving an application key.","title":"ApplicationKeyResponse"},{"location":"v2/ApplicationKeyResponse/#properties","text":"Name Type Description Notes data FullApplicationKey [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyResponseIncludedItem/","text":"ApplicationKeyResponseIncludedItem An object related to an application key. Properties Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyResponseIncludedItem"},{"location":"v2/ApplicationKeyResponseIncludedItem/#applicationkeyresponseincludeditem","text":"An object related to an application key.","title":"ApplicationKeyResponseIncludedItem"},{"location":"v2/ApplicationKeyResponseIncludedItem/#properties","text":"Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyUpdateAttributes/","text":"ApplicationKeyUpdateAttributes Attributes used to update an application Key. Properties Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyUpdateAttributes"},{"location":"v2/ApplicationKeyUpdateAttributes/#applicationkeyupdateattributes","text":"Attributes used to update an application Key.","title":"ApplicationKeyUpdateAttributes"},{"location":"v2/ApplicationKeyUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyUpdateData/","text":"ApplicationKeyUpdateData Object used to update an application key. Properties Name Type Description Notes attributes ApplicationKeyUpdateAttributes id str ID of the application key. type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyUpdateData"},{"location":"v2/ApplicationKeyUpdateData/#applicationkeyupdatedata","text":"Object used to update an application key.","title":"ApplicationKeyUpdateData"},{"location":"v2/ApplicationKeyUpdateData/#properties","text":"Name Type Description Notes attributes ApplicationKeyUpdateAttributes id str ID of the application key. type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyUpdateRequest/","text":"ApplicationKeyUpdateRequest Request used to update an application key. Properties Name Type Description Notes data ApplicationKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyUpdateRequest"},{"location":"v2/ApplicationKeyUpdateRequest/#applicationkeyupdaterequest","text":"Request used to update an application key.","title":"ApplicationKeyUpdateRequest"},{"location":"v2/ApplicationKeyUpdateRequest/#properties","text":"Name Type Description Notes data ApplicationKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeysSort/","text":"ApplicationKeysSort Sorting options Properties Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeysSort"},{"location":"v2/ApplicationKeysSort/#applicationkeyssort","text":"Sorting options","title":"ApplicationKeysSort"},{"location":"v2/ApplicationKeysSort/#properties","text":"Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeysType/","text":"ApplicationKeysType Application Keys resource type. Properties Name Type Description Notes value str Application Keys resource type. defaults to \"application_keys\", must be one of [\"application_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeysType"},{"location":"v2/ApplicationKeysType/#applicationkeystype","text":"Application Keys resource type.","title":"ApplicationKeysType"},{"location":"v2/ApplicationKeysType/#properties","text":"Name Type Description Notes value str Application Keys resource type. defaults to \"application_keys\", must be one of [\"application_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Creator/","text":"Creator Creator of the object. Properties Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Creator"},{"location":"v2/Creator/#creator","text":"Creator of the object.","title":"Creator"},{"location":"v2/Creator/#properties","text":"Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListAddItemsRequest/","text":"DashboardListAddItemsRequest Request containing a list of dashboards to add. Properties Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to add the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListAddItemsRequest"},{"location":"v2/DashboardListAddItemsRequest/#dashboardlistadditemsrequest","text":"Request containing a list of dashboards to add.","title":"DashboardListAddItemsRequest"},{"location":"v2/DashboardListAddItemsRequest/#properties","text":"Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to add the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListAddItemsResponse/","text":"DashboardListAddItemsResponse Response containing a list of added dashboards. Properties Name Type Description Notes added_dashboards_to_list [DashboardListItemResponse] List of dashboards added to the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListAddItemsResponse"},{"location":"v2/DashboardListAddItemsResponse/#dashboardlistadditemsresponse","text":"Response containing a list of added dashboards.","title":"DashboardListAddItemsResponse"},{"location":"v2/DashboardListAddItemsResponse/#properties","text":"Name Type Description Notes added_dashboards_to_list [DashboardListItemResponse] List of dashboards added to the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListDeleteItemsRequest/","text":"DashboardListDeleteItemsRequest Request containing a list of dashboards to delete. Properties Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to delete from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListDeleteItemsRequest"},{"location":"v2/DashboardListDeleteItemsRequest/#dashboardlistdeleteitemsrequest","text":"Request containing a list of dashboards to delete.","title":"DashboardListDeleteItemsRequest"},{"location":"v2/DashboardListDeleteItemsRequest/#properties","text":"Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to delete from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListDeleteItemsResponse/","text":"DashboardListDeleteItemsResponse Response containing a list of deleted dashboards. Properties Name Type Description Notes deleted_dashboards_from_list [DashboardListItemResponse] List of dashboards deleted from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListDeleteItemsResponse"},{"location":"v2/DashboardListDeleteItemsResponse/#dashboardlistdeleteitemsresponse","text":"Response containing a list of deleted dashboards.","title":"DashboardListDeleteItemsResponse"},{"location":"v2/DashboardListDeleteItemsResponse/#properties","text":"Name Type Description Notes deleted_dashboards_from_list [DashboardListItemResponse] List of dashboards deleted from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItem/","text":"DashboardListItem A dashboard within a list. Properties Name Type Description Notes id str ID of the dashboard. type DashboardType author Creator [optional] created datetime Date of creation of the dashboard. optional icon str URL to the icon of the dashboard. optional is_favorite bool Whether or not the dashboard is in the favorites. optional is_read_only bool Whether or not the dashboard is read only. optional is_shared bool Whether the dashboard is publicly shared or not. optional modified datetime Date of last edition of the dashboard. optional popularity int Popularity of the dashboard. optional title str Title of the dashboard. optional url str URL path to the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItem"},{"location":"v2/DashboardListItem/#dashboardlistitem","text":"A dashboard within a list.","title":"DashboardListItem"},{"location":"v2/DashboardListItem/#properties","text":"Name Type Description Notes id str ID of the dashboard. type DashboardType author Creator [optional] created datetime Date of creation of the dashboard. optional icon str URL to the icon of the dashboard. optional is_favorite bool Whether or not the dashboard is in the favorites. optional is_read_only bool Whether or not the dashboard is read only. optional is_shared bool Whether the dashboard is publicly shared or not. optional modified datetime Date of last edition of the dashboard. optional popularity int Popularity of the dashboard. optional title str Title of the dashboard. optional url str URL path to the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItemRequest/","text":"DashboardListItemRequest A dashboard within a list. Properties Name Type Description Notes id str ID of the dashboard. type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItemRequest"},{"location":"v2/DashboardListItemRequest/#dashboardlistitemrequest","text":"A dashboard within a list.","title":"DashboardListItemRequest"},{"location":"v2/DashboardListItemRequest/#properties","text":"Name Type Description Notes id str ID of the dashboard. type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItemResponse/","text":"DashboardListItemResponse A dashboard within a list. Properties Name Type Description Notes id str ID of the dashboard. [readonly] type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItemResponse"},{"location":"v2/DashboardListItemResponse/#dashboardlistitemresponse","text":"A dashboard within a list.","title":"DashboardListItemResponse"},{"location":"v2/DashboardListItemResponse/#properties","text":"Name Type Description Notes id str ID of the dashboard. [readonly] type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItems/","text":"DashboardListItems Dashboards within a list. Properties Name Type Description Notes dashboards [DashboardListItem] List of dashboards in the dashboard list. total int Number of dashboards in the dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItems"},{"location":"v2/DashboardListItems/#dashboardlistitems","text":"Dashboards within a list.","title":"DashboardListItems"},{"location":"v2/DashboardListItems/#properties","text":"Name Type Description Notes dashboards [DashboardListItem] List of dashboards in the dashboard list. total int Number of dashboards in the dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListUpdateItemsRequest/","text":"DashboardListUpdateItemsRequest Request containing the list of dashboards to update to. Properties Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to update the dashboard list to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListUpdateItemsRequest"},{"location":"v2/DashboardListUpdateItemsRequest/#dashboardlistupdateitemsrequest","text":"Request containing the list of dashboards to update to.","title":"DashboardListUpdateItemsRequest"},{"location":"v2/DashboardListUpdateItemsRequest/#properties","text":"Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to update the dashboard list to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListUpdateItemsResponse/","text":"DashboardListUpdateItemsResponse Response containing a list of updated dashboards. Properties Name Type Description Notes dashboards [DashboardListItemResponse] List of dashboards in the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListUpdateItemsResponse"},{"location":"v2/DashboardListUpdateItemsResponse/#dashboardlistupdateitemsresponse","text":"Response containing a list of updated dashboards.","title":"DashboardListUpdateItemsResponse"},{"location":"v2/DashboardListUpdateItemsResponse/#properties","text":"Name Type Description Notes dashboards [DashboardListItemResponse] List of dashboards in the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListsApi/","text":"datadog_api_client.v2.DashboardListsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list create_dashboard_list_items DashboardListAddItemsResponse create_dashboard_list_items(dashboard_list_id, body) Add Items to a Dashboard List Add dashboards to an existing dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. # example passing only required values which don't have defaults set try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to add items to. body DashboardListAddItemsRequest Dashboards to add to the dashboard list. Return type DashboardListAddItemsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_dashboard_list_items DashboardListDeleteItemsResponse delete_dashboard_list_items(dashboard_list_id, body) Delete items from a dashboard list Delete dashboards from an existing dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to delete items from. body = DashboardListDeleteItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListDeleteItemsRequest | Dashboards to delete from the dashboard list. # example passing only required values which don't have defaults set try: # Delete items from a dashboard list api_response = api_instance.delete_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to delete items from. body DashboardListDeleteItemsRequest Dashboards to delete from the dashboard list. Return type DashboardListDeleteItemsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_dashboard_list_items DashboardListItems get_dashboard_list_items(dashboard_list_id) Get items of a Dashboard List Fetch the dashboard list\u2019s dashboard definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to get items from. # example passing only required values which don't have defaults set try: # Get items of a Dashboard List api_response = api_instance.get_dashboard_list_items(dashboard_list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to get items from. Return type DashboardListItems Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_dashboard_list_items DashboardListUpdateItemsResponse update_dashboard_list_items(dashboard_list_id, body) Update items of a dashboard list Update dashboards of an existing dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to update items from. body = DashboardListUpdateItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListUpdateItemsRequest | New dashboards of the dashboard list. # example passing only required values which don't have defaults set try: # Update items of a dashboard list api_response = api_instance.update_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to update items from. body DashboardListUpdateItemsRequest New dashboards of the dashboard list. Return type DashboardListUpdateItemsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.DashboardListsApi"},{"location":"v2/DashboardListsApi/#datadog_api_clientv2dashboardlistsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list","title":"datadog_api_client.v2.DashboardListsApi"},{"location":"v2/DashboardListsApi/#create_dashboard_list_items","text":"DashboardListAddItemsResponse create_dashboard_list_items(dashboard_list_id, body) Add Items to a Dashboard List Add dashboards to an existing dashboard list.","title":"create_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. # example passing only required values which don't have defaults set try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to add items to. body DashboardListAddItemsRequest Dashboards to add to the dashboard list.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type","text":"DashboardListAddItemsResponse","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardListsApi/#delete_dashboard_list_items","text":"DashboardListDeleteItemsResponse delete_dashboard_list_items(dashboard_list_id, body) Delete items from a dashboard list Delete dashboards from an existing dashboard list.","title":"delete_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to delete items from. body = DashboardListDeleteItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListDeleteItemsRequest | Dashboards to delete from the dashboard list. # example passing only required values which don't have defaults set try: # Delete items from a dashboard list api_response = api_instance.delete_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters_1","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to delete items from. body DashboardListDeleteItemsRequest Dashboards to delete from the dashboard list.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type_1","text":"DashboardListDeleteItemsResponse","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardListsApi/#get_dashboard_list_items","text":"DashboardListItems get_dashboard_list_items(dashboard_list_id) Get items of a Dashboard List Fetch the dashboard list\u2019s dashboard definitions.","title":"get_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to get items from. # example passing only required values which don't have defaults set try: # Get items of a Dashboard List api_response = api_instance.get_dashboard_list_items(dashboard_list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters_2","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to get items from.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type_2","text":"DashboardListItems","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardListsApi/#update_dashboard_list_items","text":"DashboardListUpdateItemsResponse update_dashboard_list_items(dashboard_list_id, body) Update items of a dashboard list Update dashboards of an existing dashboard list.","title":"update_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to update items from. body = DashboardListUpdateItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListUpdateItemsRequest | New dashboards of the dashboard list. # example passing only required values which don't have defaults set try: # Update items of a dashboard list api_response = api_instance.update_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters_3","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to update items from. body DashboardListUpdateItemsRequest New dashboards of the dashboard list.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type_3","text":"DashboardListUpdateItemsResponse","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardType/","text":"DashboardType The type of the dashboard. Properties Name Type Description Notes value str The type of the dashboard. must be one of [\"custom_timeboard\", \"custom_screenboard\", \"integration_screenboard\", \"integration_timeboard\", \"host_timeboard\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardType"},{"location":"v2/DashboardType/#dashboardtype","text":"The type of the dashboard.","title":"DashboardType"},{"location":"v2/DashboardType/#properties","text":"Name Type Description Notes value str The type of the dashboard. must be one of [\"custom_timeboard\", \"custom_screenboard\", \"integration_screenboard\", \"integration_timeboard\", \"host_timeboard\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullAPIKey/","text":"FullAPIKey Datadog API key. Properties Name Type Description Notes attributes FullAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullAPIKey"},{"location":"v2/FullAPIKey/#fullapikey","text":"Datadog API key.","title":"FullAPIKey"},{"location":"v2/FullAPIKey/#properties","text":"Name Type Description Notes attributes FullAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullAPIKeyAttributes/","text":"FullAPIKeyAttributes Attributes of a full API key. Properties Name Type Description Notes created_at str Creation date of the API key. optional key str The API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullAPIKeyAttributes"},{"location":"v2/FullAPIKeyAttributes/#fullapikeyattributes","text":"Attributes of a full API key.","title":"FullAPIKeyAttributes"},{"location":"v2/FullAPIKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the API key. optional key str The API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullApplicationKey/","text":"FullApplicationKey Datadog application key. Properties Name Type Description Notes attributes FullApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullApplicationKey"},{"location":"v2/FullApplicationKey/#fullapplicationkey","text":"Datadog application key.","title":"FullApplicationKey"},{"location":"v2/FullApplicationKey/#properties","text":"Name Type Description Notes attributes FullApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullApplicationKeyAttributes/","text":"FullApplicationKeyAttributes Attributes of a full application key. Properties Name Type Description Notes created_at str Creation date of the application key. optional key str The application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullApplicationKeyAttributes"},{"location":"v2/FullApplicationKeyAttributes/#fullapplicationkeyattributes","text":"Attributes of a full application key.","title":"FullApplicationKeyAttributes"},{"location":"v2/FullApplicationKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the application key. optional key str The application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateAttributes/","text":"IncidentCreateAttributes The incident's attributes for a create request. Properties Name Type Description Notes customer_impacted bool A flag indicating whether the incident caused customer impact. title str The title of the incident, which summarizes what happened. fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to create initial selections. [optional] initial_timeline_cells [IncidentTimelineCellCreateAttributes] An array of initial timeline cells to be placed at the beginning of the incident timeline. [optional] notification_handles [str] Notification handles that will be notified of the incident at creation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateAttributes"},{"location":"v2/IncidentCreateAttributes/#incidentcreateattributes","text":"The incident's attributes for a create request.","title":"IncidentCreateAttributes"},{"location":"v2/IncidentCreateAttributes/#properties","text":"Name Type Description Notes customer_impacted bool A flag indicating whether the incident caused customer impact. title str The title of the incident, which summarizes what happened. fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to create initial selections. [optional] initial_timeline_cells [IncidentTimelineCellCreateAttributes] An array of initial timeline cells to be placed at the beginning of the incident timeline. [optional] notification_handles [str] Notification handles that will be notified of the incident at creation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateData/","text":"IncidentCreateData Incident data for a create request. Properties Name Type Description Notes attributes IncidentCreateAttributes type IncidentType relationships IncidentCreateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateData"},{"location":"v2/IncidentCreateData/#incidentcreatedata","text":"Incident data for a create request.","title":"IncidentCreateData"},{"location":"v2/IncidentCreateData/#properties","text":"Name Type Description Notes attributes IncidentCreateAttributes type IncidentType relationships IncidentCreateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateRelationships/","text":"IncidentCreateRelationships The relationships the incident will have with other resources once created. Properties Name Type Description Notes commander RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateRelationships"},{"location":"v2/IncidentCreateRelationships/#incidentcreaterelationships","text":"The relationships the incident will have with other resources once created.","title":"IncidentCreateRelationships"},{"location":"v2/IncidentCreateRelationships/#properties","text":"Name Type Description Notes commander RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateRequest/","text":"IncidentCreateRequest Create request for an incident. Properties Name Type Description Notes data IncidentCreateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateRequest"},{"location":"v2/IncidentCreateRequest/#incidentcreaterequest","text":"Create request for an incident.","title":"IncidentCreateRequest"},{"location":"v2/IncidentCreateRequest/#properties","text":"Name Type Description Notes data IncidentCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributes/","text":"IncidentFieldAttributes Dynamic fields for which selections can be made, with field names as keys. Properties Name Type Description Notes type IncidentFieldAttributesValueType value [str] The multiple values selected for this field. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributes"},{"location":"v2/IncidentFieldAttributes/#incidentfieldattributes","text":"Dynamic fields for which selections can be made, with field names as keys.","title":"IncidentFieldAttributes"},{"location":"v2/IncidentFieldAttributes/#properties","text":"Name Type Description Notes type IncidentFieldAttributesValueType value [str] The multiple values selected for this field. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesMultipleValue/","text":"IncidentFieldAttributesMultipleValue A field with potentially multiple values selected. Properties Name Type Description Notes type IncidentFieldAttributesValueType [optional] value [str] The multiple values selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesMultipleValue"},{"location":"v2/IncidentFieldAttributesMultipleValue/#incidentfieldattributesmultiplevalue","text":"A field with potentially multiple values selected.","title":"IncidentFieldAttributesMultipleValue"},{"location":"v2/IncidentFieldAttributesMultipleValue/#properties","text":"Name Type Description Notes type IncidentFieldAttributesValueType [optional] value [str] The multiple values selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesSingleValue/","text":"IncidentFieldAttributesSingleValue A field with a single value selected. Properties Name Type Description Notes type IncidentFieldAttributesSingleValueType [optional] value str The single value selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesSingleValue"},{"location":"v2/IncidentFieldAttributesSingleValue/#incidentfieldattributessinglevalue","text":"A field with a single value selected.","title":"IncidentFieldAttributesSingleValue"},{"location":"v2/IncidentFieldAttributesSingleValue/#properties","text":"Name Type Description Notes type IncidentFieldAttributesSingleValueType [optional] value str The single value selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesSingleValueType/","text":"IncidentFieldAttributesSingleValueType Type of the single value field definitions. Properties Name Type Description Notes value str Type of the single value field definitions. defaults to \"dropdown\", must be one of [\"dropdown\", \"textbox\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesSingleValueType"},{"location":"v2/IncidentFieldAttributesSingleValueType/#incidentfieldattributessinglevaluetype","text":"Type of the single value field definitions.","title":"IncidentFieldAttributesSingleValueType"},{"location":"v2/IncidentFieldAttributesSingleValueType/#properties","text":"Name Type Description Notes value str Type of the single value field definitions. defaults to \"dropdown\", must be one of [\"dropdown\", \"textbox\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesValueType/","text":"IncidentFieldAttributesValueType Type of the single value field definitions. Properties Name Type Description Notes value str Type of the single value field definitions. defaults to \"multiselect\", must be one of [\"multiselect\", \"textarray\", \"metrictag\", \"autocomplete\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesValueType"},{"location":"v2/IncidentFieldAttributesValueType/#incidentfieldattributesvaluetype","text":"Type of the single value field definitions.","title":"IncidentFieldAttributesValueType"},{"location":"v2/IncidentFieldAttributesValueType/#properties","text":"Name Type Description Notes value str Type of the single value field definitions. defaults to \"multiselect\", must be one of [\"multiselect\", \"textarray\", \"metrictag\", \"autocomplete\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentIntegrationMetadataType/","text":"IncidentIntegrationMetadataType Integration metadata resource type. Properties Name Type Description Notes value str Integration metadata resource type. defaults to \"incident_integration_metadata\", must be one of [\"incident_integration_metadata\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentIntegrationMetadataType"},{"location":"v2/IncidentIntegrationMetadataType/#incidentintegrationmetadatatype","text":"Integration metadata resource type.","title":"IncidentIntegrationMetadataType"},{"location":"v2/IncidentIntegrationMetadataType/#properties","text":"Name Type Description Notes value str Integration metadata resource type. defaults to \"incident_integration_metadata\", must be one of [\"incident_integration_metadata\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentPostmortemType/","text":"IncidentPostmortemType Incident postmortem resource type. Properties Name Type Description Notes value str Incident postmortem resource type. defaults to \"incident_postmortems\", must be one of [\"incident_postmortems\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentPostmortemType"},{"location":"v2/IncidentPostmortemType/#incidentpostmortemtype","text":"Incident postmortem resource type.","title":"IncidentPostmortemType"},{"location":"v2/IncidentPostmortemType/#properties","text":"Name Type Description Notes value str Incident postmortem resource type. defaults to \"incident_postmortems\", must be one of [\"incident_postmortems\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentRelatedObject/","text":"IncidentRelatedObject Object related to an incident. Properties Name Type Description Notes value str Object related to an incident. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentRelatedObject"},{"location":"v2/IncidentRelatedObject/#incidentrelatedobject","text":"Object related to an incident.","title":"IncidentRelatedObject"},{"location":"v2/IncidentRelatedObject/#properties","text":"Name Type Description Notes value str Object related to an incident. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponse/","text":"IncidentResponse Response with an incident. Properties Name Type Description Notes data IncidentResponseData included [IncidentResponseIncludedItem] Included related resources that the user requested. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponse"},{"location":"v2/IncidentResponse/#incidentresponse","text":"Response with an incident.","title":"IncidentResponse"},{"location":"v2/IncidentResponse/#properties","text":"Name Type Description Notes data IncidentResponseData included [IncidentResponseIncludedItem] Included related resources that the user requested. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseAttributes/","text":"IncidentResponseAttributes The incident's attributes from a response. Properties Name Type Description Notes title str The title of the incident, which summarizes what happened. created datetime Timestamp when the incident was created. optional customer_impact_duration int Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. optional customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str, none_type A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields attached to incidents. [optional] modified datetime Timestamp when the incident was last modified. optional notification_handles [str] Notification handles that will be notified of the incident during update. [optional] postmortem_id str The UUID of the postmortem object attached to the incident. [optional] public_id int The monotonically increasing integer ID for the incident. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] time_to_detect int The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. optional time_to_internal_response int The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. optional time_to_repair int The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. optional time_to_resolve int The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseAttributes"},{"location":"v2/IncidentResponseAttributes/#incidentresponseattributes","text":"The incident's attributes from a response.","title":"IncidentResponseAttributes"},{"location":"v2/IncidentResponseAttributes/#properties","text":"Name Type Description Notes title str The title of the incident, which summarizes what happened. created datetime Timestamp when the incident was created. optional customer_impact_duration int Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. optional customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str, none_type A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields attached to incidents. [optional] modified datetime Timestamp when the incident was last modified. optional notification_handles [str] Notification handles that will be notified of the incident during update. [optional] postmortem_id str The UUID of the postmortem object attached to the incident. [optional] public_id int The monotonically increasing integer ID for the incident. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] time_to_detect int The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. optional time_to_internal_response int The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. optional time_to_repair int The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. optional time_to_resolve int The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseData/","text":"IncidentResponseData Incident data from a response. Properties Name Type Description Notes id str The incident's ID. type IncidentType attributes IncidentResponseAttributes [optional] relationships IncidentResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseData"},{"location":"v2/IncidentResponseData/#incidentresponsedata","text":"Incident data from a response.","title":"IncidentResponseData"},{"location":"v2/IncidentResponseData/#properties","text":"Name Type Description Notes id str The incident's ID. type IncidentType attributes IncidentResponseAttributes [optional] relationships IncidentResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseIncludedItem/","text":"IncidentResponseIncludedItem An object related to an incident that is included in the response. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseIncludedItem"},{"location":"v2/IncidentResponseIncludedItem/#incidentresponseincludeditem","text":"An object related to an incident that is included in the response.","title":"IncidentResponseIncludedItem"},{"location":"v2/IncidentResponseIncludedItem/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseRelationships/","text":"IncidentResponseRelationships The incident's relationships from a response. Properties Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseRelationships"},{"location":"v2/IncidentResponseRelationships/#incidentresponserelationships","text":"The incident's relationships from a response.","title":"IncidentResponseRelationships"},{"location":"v2/IncidentResponseRelationships/#properties","text":"Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceCreateAttributes/","text":"IncidentServiceCreateAttributes The incident service's attributes for a create request. Properties Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceCreateAttributes"},{"location":"v2/IncidentServiceCreateAttributes/#incidentservicecreateattributes","text":"The incident service's attributes for a create request.","title":"IncidentServiceCreateAttributes"},{"location":"v2/IncidentServiceCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceCreateData/","text":"IncidentServiceCreateData Incident Service payload for create requests. Properties Name Type Description Notes type IncidentServiceType attributes IncidentServiceCreateAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceCreateData"},{"location":"v2/IncidentServiceCreateData/#incidentservicecreatedata","text":"Incident Service payload for create requests.","title":"IncidentServiceCreateData"},{"location":"v2/IncidentServiceCreateData/#properties","text":"Name Type Description Notes type IncidentServiceType attributes IncidentServiceCreateAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceCreateRequest/","text":"IncidentServiceCreateRequest Create request with an incident service payload. Properties Name Type Description Notes data IncidentServiceCreateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceCreateRequest"},{"location":"v2/IncidentServiceCreateRequest/#incidentservicecreaterequest","text":"Create request with an incident service payload.","title":"IncidentServiceCreateRequest"},{"location":"v2/IncidentServiceCreateRequest/#properties","text":"Name Type Description Notes data IncidentServiceCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceIncludedItems/","text":"IncidentServiceIncludedItems An object related to an incident service which is present in the included payload. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceIncludedItems"},{"location":"v2/IncidentServiceIncludedItems/#incidentserviceincludeditems","text":"An object related to an incident service which is present in the included payload.","title":"IncidentServiceIncludedItems"},{"location":"v2/IncidentServiceIncludedItems/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceRelationships/","text":"IncidentServiceRelationships The incident service's relationships. Properties Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceRelationships"},{"location":"v2/IncidentServiceRelationships/#incidentservicerelationships","text":"The incident service's relationships.","title":"IncidentServiceRelationships"},{"location":"v2/IncidentServiceRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceResponse/","text":"IncidentServiceResponse Response with an incident service payload. Properties Name Type Description Notes data IncidentServiceResponseData included [IncidentServiceIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceResponse"},{"location":"v2/IncidentServiceResponse/#incidentserviceresponse","text":"Response with an incident service payload.","title":"IncidentServiceResponse"},{"location":"v2/IncidentServiceResponse/#properties","text":"Name Type Description Notes data IncidentServiceResponseData included [IncidentServiceIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceResponseAttributes/","text":"IncidentServiceResponseAttributes The incident service's attributes from a response. Properties Name Type Description Notes created datetime Timestamp of when the incident service was created. optional modified datetime Timestamp of when the incident service was modified. optional name str Name of the incident service. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceResponseAttributes"},{"location":"v2/IncidentServiceResponseAttributes/#incidentserviceresponseattributes","text":"The incident service's attributes from a response.","title":"IncidentServiceResponseAttributes"},{"location":"v2/IncidentServiceResponseAttributes/#properties","text":"Name Type Description Notes created datetime Timestamp of when the incident service was created. optional modified datetime Timestamp of when the incident service was modified. optional name str Name of the incident service. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceResponseData/","text":"IncidentServiceResponseData Incident Service data from responses. Properties Name Type Description Notes id str The incident service's ID. type IncidentServiceType attributes IncidentServiceResponseAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceResponseData"},{"location":"v2/IncidentServiceResponseData/#incidentserviceresponsedata","text":"Incident Service data from responses.","title":"IncidentServiceResponseData"},{"location":"v2/IncidentServiceResponseData/#properties","text":"Name Type Description Notes id str The incident service's ID. type IncidentServiceType attributes IncidentServiceResponseAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceType/","text":"IncidentServiceType Incident service resource type. Properties Name Type Description Notes value str Incident service resource type. defaults to \"services\", must be one of [\"services\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceType"},{"location":"v2/IncidentServiceType/#incidentservicetype","text":"Incident service resource type.","title":"IncidentServiceType"},{"location":"v2/IncidentServiceType/#properties","text":"Name Type Description Notes value str Incident service resource type. defaults to \"services\", must be one of [\"services\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceUpdateAttributes/","text":"IncidentServiceUpdateAttributes The incident service's attributes for an update request. Properties Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceUpdateAttributes"},{"location":"v2/IncidentServiceUpdateAttributes/#incidentserviceupdateattributes","text":"The incident service's attributes for an update request.","title":"IncidentServiceUpdateAttributes"},{"location":"v2/IncidentServiceUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceUpdateData/","text":"IncidentServiceUpdateData Incident Service payload for update requests. Properties Name Type Description Notes type IncidentServiceType attributes IncidentServiceUpdateAttributes [optional] id str The incident service's ID. [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceUpdateData"},{"location":"v2/IncidentServiceUpdateData/#incidentserviceupdatedata","text":"Incident Service payload for update requests.","title":"IncidentServiceUpdateData"},{"location":"v2/IncidentServiceUpdateData/#properties","text":"Name Type Description Notes type IncidentServiceType attributes IncidentServiceUpdateAttributes [optional] id str The incident service's ID. [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceUpdateRequest/","text":"IncidentServiceUpdateRequest Update request with an incident service payload. Properties Name Type Description Notes data IncidentServiceUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceUpdateRequest"},{"location":"v2/IncidentServiceUpdateRequest/#incidentserviceupdaterequest","text":"Update request with an incident service payload.","title":"IncidentServiceUpdateRequest"},{"location":"v2/IncidentServiceUpdateRequest/#properties","text":"Name Type Description Notes data IncidentServiceUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServicesApi/","text":"datadog_api_client.v2.IncidentServicesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_service POST /api/v2/services Create a new incident service delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service get_incident_service GET /api/v2/services/{service_id} Get details of an incident service list_incident_services GET /api/v2/services Get a list of all incident services update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service create_incident_service IncidentServiceResponse create_incident_service(body) Create a new incident service Creates a new incident service. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) body = IncidentServiceCreateRequest( data=IncidentServiceCreateData( attributes=IncidentServiceCreateAttributes( name=\"an example service name\", ), relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceCreateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Create a new incident service api_response = api_instance.create_incident_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->create_incident_service: %s\\n\" % e) Parameters Name Type Description Notes body IncidentServiceCreateRequest Incident Service Payload. Return type IncidentServiceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_incident_service delete_incident_service(service_id) Delete an existing incident service Deletes an existing incident service. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. # example passing only required values which don't have defaults set try: # Delete an existing incident service api_instance.delete_incident_service(service_id) except ApiException as e: print(\"Exception when calling IncidentServicesApi->delete_incident_service: %s\\n\" % e) Parameters Name Type Description Notes service_id str The ID of the incident service. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident_service IncidentServiceResponse get_incident_service(service_id) Get details of an incident service Get details of an incident service. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e) Parameters Name Type Description Notes service_id str The ID of the incident service. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] Return type IncidentServiceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_incident_services IncidentServicesResponse list_incident_services() Get a list of all incident services Get all incident services uploaded for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_services\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleServiceName\" # str | A search query that filters services by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident services api_response = api_instance.list_incident_services(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->list_incident_services: %s\\n\" % e) Parameters Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters services by name. [optional] Return type IncidentServicesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_incident_service IncidentServiceResponse update_incident_service(service_id, body) Update an existing incident service Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. body = IncidentServiceUpdateRequest( data=IncidentServiceUpdateData( attributes=IncidentServiceUpdateAttributes( name=\"an example service name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceUpdateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Update an existing incident service api_response = api_instance.update_incident_service(service_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->update_incident_service: %s\\n\" % e) Parameters Name Type Description Notes service_id str The ID of the incident service. body IncidentServiceUpdateRequest Incident Service Payload. Return type IncidentServiceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.IncidentServicesApi"},{"location":"v2/IncidentServicesApi/#datadog_api_clientv2incidentservicesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_service POST /api/v2/services Create a new incident service delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service get_incident_service GET /api/v2/services/{service_id} Get details of an incident service list_incident_services GET /api/v2/services Get a list of all incident services update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service","title":"datadog_api_client.v2.IncidentServicesApi"},{"location":"v2/IncidentServicesApi/#create_incident_service","text":"IncidentServiceResponse create_incident_service(body) Create a new incident service Creates a new incident service.","title":"create_incident_service"},{"location":"v2/IncidentServicesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) body = IncidentServiceCreateRequest( data=IncidentServiceCreateData( attributes=IncidentServiceCreateAttributes( name=\"an example service name\", ), relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceCreateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Create a new incident service api_response = api_instance.create_incident_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->create_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters","text":"Name Type Description Notes body IncidentServiceCreateRequest Incident Service Payload.","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type","text":"IncidentServiceResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details","text":"Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#delete_incident_service","text":"delete_incident_service(service_id) Delete an existing incident service Deletes an existing incident service.","title":"delete_incident_service"},{"location":"v2/IncidentServicesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. # example passing only required values which don't have defaults set try: # Delete an existing incident service api_instance.delete_incident_service(service_id) except ApiException as e: print(\"Exception when calling IncidentServicesApi->delete_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_1","text":"Name Type Description Notes service_id str The ID of the incident service.","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#get_incident_service","text":"IncidentServiceResponse get_incident_service(service_id) Get details of an incident service Get details of an incident service. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.","title":"get_incident_service"},{"location":"v2/IncidentServicesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_2","text":"Name Type Description Notes service_id str The ID of the incident service. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional]","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_2","text":"IncidentServiceResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#list_incident_services","text":"IncidentServicesResponse list_incident_services() Get a list of all incident services Get all incident services uploaded for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.","title":"list_incident_services"},{"location":"v2/IncidentServicesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_services\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleServiceName\" # str | A search query that filters services by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident services api_response = api_instance.list_incident_services(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->list_incident_services: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_3","text":"Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters services by name. [optional]","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_3","text":"IncidentServicesResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#update_incident_service","text":"IncidentServiceResponse update_incident_service(service_id, body) Update an existing incident service Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update.","title":"update_incident_service"},{"location":"v2/IncidentServicesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. body = IncidentServiceUpdateRequest( data=IncidentServiceUpdateData( attributes=IncidentServiceUpdateAttributes( name=\"an example service name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceUpdateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Update an existing incident service api_response = api_instance.update_incident_service(service_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->update_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_4","text":"Name Type Description Notes service_id str The ID of the incident service. body IncidentServiceUpdateRequest Incident Service Payload.","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_4","text":"IncidentServiceResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesResponse/","text":"IncidentServicesResponse Response with a list of incident service payloads. Properties Name Type Description Notes data [IncidentServiceResponseData] An array of incident services. included [IncidentServiceIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServicesResponse"},{"location":"v2/IncidentServicesResponse/#incidentservicesresponse","text":"Response with a list of incident service payloads.","title":"IncidentServicesResponse"},{"location":"v2/IncidentServicesResponse/#properties","text":"Name Type Description Notes data [IncidentServiceResponseData] An array of incident services. included [IncidentServiceIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServicesResponseMeta/","text":"IncidentServicesResponseMeta The metadata object containing pagination metadata. Properties Name Type Description Notes pagination IncidentServicesResponseMetaPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServicesResponseMeta"},{"location":"v2/IncidentServicesResponseMeta/#incidentservicesresponsemeta","text":"The metadata object containing pagination metadata.","title":"IncidentServicesResponseMeta"},{"location":"v2/IncidentServicesResponseMeta/#properties","text":"Name Type Description Notes pagination IncidentServicesResponseMetaPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServicesResponseMetaPagination/","text":"IncidentServicesResponseMetaPagination Pagination properties. Properties Name Type Description Notes next_offset int The index of the first element in the next page of results. Equal to page size added to the current offset. [optional] offset int The index of the first element in the results. [optional] size int Maximum size of pages to return. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServicesResponseMetaPagination"},{"location":"v2/IncidentServicesResponseMetaPagination/#incidentservicesresponsemetapagination","text":"Pagination properties.","title":"IncidentServicesResponseMetaPagination"},{"location":"v2/IncidentServicesResponseMetaPagination/#properties","text":"Name Type Description Notes next_offset int The index of the first element in the next page of results. Equal to page size added to the current offset. [optional] offset int The index of the first element in the results. [optional] size int Maximum size of pages to return. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamCreateAttributes/","text":"IncidentTeamCreateAttributes The incident team's attributes for a create request. Properties Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamCreateAttributes"},{"location":"v2/IncidentTeamCreateAttributes/#incidentteamcreateattributes","text":"The incident team's attributes for a create request.","title":"IncidentTeamCreateAttributes"},{"location":"v2/IncidentTeamCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamCreateData/","text":"IncidentTeamCreateData Incident Team data for a create request. Properties Name Type Description Notes type IncidentTeamType attributes IncidentTeamCreateAttributes [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamCreateData"},{"location":"v2/IncidentTeamCreateData/#incidentteamcreatedata","text":"Incident Team data for a create request.","title":"IncidentTeamCreateData"},{"location":"v2/IncidentTeamCreateData/#properties","text":"Name Type Description Notes type IncidentTeamType attributes IncidentTeamCreateAttributes [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamCreateRequest/","text":"IncidentTeamCreateRequest Create request with an incident team payload. Properties Name Type Description Notes data IncidentTeamCreateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamCreateRequest"},{"location":"v2/IncidentTeamCreateRequest/#incidentteamcreaterequest","text":"Create request with an incident team payload.","title":"IncidentTeamCreateRequest"},{"location":"v2/IncidentTeamCreateRequest/#properties","text":"Name Type Description Notes data IncidentTeamCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamIncludedItems/","text":"IncidentTeamIncludedItems An object related to an incident team which is present in the included payload. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamIncludedItems"},{"location":"v2/IncidentTeamIncludedItems/#incidentteamincludeditems","text":"An object related to an incident team which is present in the included payload.","title":"IncidentTeamIncludedItems"},{"location":"v2/IncidentTeamIncludedItems/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamRelationships/","text":"IncidentTeamRelationships The incident team's relationships. Properties Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamRelationships"},{"location":"v2/IncidentTeamRelationships/#incidentteamrelationships","text":"The incident team's relationships.","title":"IncidentTeamRelationships"},{"location":"v2/IncidentTeamRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamResponse/","text":"IncidentTeamResponse Response with an incident team payload. Properties Name Type Description Notes data IncidentTeamResponseData included [IncidentTeamIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamResponse"},{"location":"v2/IncidentTeamResponse/#incidentteamresponse","text":"Response with an incident team payload.","title":"IncidentTeamResponse"},{"location":"v2/IncidentTeamResponse/#properties","text":"Name Type Description Notes data IncidentTeamResponseData included [IncidentTeamIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamResponseAttributes/","text":"IncidentTeamResponseAttributes The incident team's attributes from a response. Properties Name Type Description Notes created datetime Timestamp of when the incident team was created. optional modified datetime Timestamp of when the incident team was modified. optional name str Name of the incident team. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamResponseAttributes"},{"location":"v2/IncidentTeamResponseAttributes/#incidentteamresponseattributes","text":"The incident team's attributes from a response.","title":"IncidentTeamResponseAttributes"},{"location":"v2/IncidentTeamResponseAttributes/#properties","text":"Name Type Description Notes created datetime Timestamp of when the incident team was created. optional modified datetime Timestamp of when the incident team was modified. optional name str Name of the incident team. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamResponseData/","text":"IncidentTeamResponseData Incident Team data from a response. Properties Name Type Description Notes attributes IncidentTeamResponseAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] type IncidentTeamType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamResponseData"},{"location":"v2/IncidentTeamResponseData/#incidentteamresponsedata","text":"Incident Team data from a response.","title":"IncidentTeamResponseData"},{"location":"v2/IncidentTeamResponseData/#properties","text":"Name Type Description Notes attributes IncidentTeamResponseAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] type IncidentTeamType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamType/","text":"IncidentTeamType Incident Team resource type. Properties Name Type Description Notes value str Incident Team resource type. defaults to \"teams\", must be one of [\"teams\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamType"},{"location":"v2/IncidentTeamType/#incidentteamtype","text":"Incident Team resource type.","title":"IncidentTeamType"},{"location":"v2/IncidentTeamType/#properties","text":"Name Type Description Notes value str Incident Team resource type. defaults to \"teams\", must be one of [\"teams\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamUpdateAttributes/","text":"IncidentTeamUpdateAttributes The incident team's attributes for an update request. Properties Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamUpdateAttributes"},{"location":"v2/IncidentTeamUpdateAttributes/#incidentteamupdateattributes","text":"The incident team's attributes for an update request.","title":"IncidentTeamUpdateAttributes"},{"location":"v2/IncidentTeamUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamUpdateData/","text":"IncidentTeamUpdateData Incident Team data for an update request. Properties Name Type Description Notes type IncidentTeamType attributes IncidentTeamUpdateAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamUpdateData"},{"location":"v2/IncidentTeamUpdateData/#incidentteamupdatedata","text":"Incident Team data for an update request.","title":"IncidentTeamUpdateData"},{"location":"v2/IncidentTeamUpdateData/#properties","text":"Name Type Description Notes type IncidentTeamType attributes IncidentTeamUpdateAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamUpdateRequest/","text":"IncidentTeamUpdateRequest Update request with an incident team payload. Properties Name Type Description Notes data IncidentTeamUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamUpdateRequest"},{"location":"v2/IncidentTeamUpdateRequest/#incidentteamupdaterequest","text":"Update request with an incident team payload.","title":"IncidentTeamUpdateRequest"},{"location":"v2/IncidentTeamUpdateRequest/#properties","text":"Name Type Description Notes data IncidentTeamUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamsApi/","text":"datadog_api_client.v2.IncidentTeamsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_team POST /api/v2/teams Create a new incident team delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team list_incident_teams GET /api/v2/teams Get a list of all incident teams update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team create_incident_team IncidentTeamResponse create_incident_team(body) Create a new incident team Creates a new incident team. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) body = IncidentTeamCreateRequest( data=IncidentTeamCreateData( attributes=IncidentTeamCreateAttributes( name=\"team name\", ), relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamCreateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Create a new incident team api_response = api_instance.create_incident_team(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->create_incident_team: %s\\n\" % e) Parameters Name Type Description Notes body IncidentTeamCreateRequest Incident Team Payload. Return type IncidentTeamResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_incident_team delete_incident_team(team_id) Delete an existing incident team Deletes an existing incident team. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. # example passing only required values which don't have defaults set try: # Delete an existing incident team api_instance.delete_incident_team(team_id) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->delete_incident_team: %s\\n\" % e) Parameters Name Type Description Notes team_id str The ID of the incident team. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident_team IncidentTeamResponse get_incident_team(team_id) Get details of an incident team Get details of an incident team. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e) Parameters Name Type Description Notes team_id str The ID of the incident team. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] Return type IncidentTeamResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_incident_teams IncidentTeamsResponse list_incident_teams() Get a list of all incident teams Get all incident teams for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_teams\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleTeamName\" # str | A search query that filters teams by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident teams api_response = api_instance.list_incident_teams(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->list_incident_teams: %s\\n\" % e) Parameters Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters teams by name. [optional] Return type IncidentTeamsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_incident_team IncidentTeamResponse update_incident_team(team_id, body) Update an existing incident team Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. body = IncidentTeamUpdateRequest( data=IncidentTeamUpdateData( attributes=IncidentTeamUpdateAttributes( name=\"team name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamUpdateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Update an existing incident team api_response = api_instance.update_incident_team(team_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->update_incident_team: %s\\n\" % e) Parameters Name Type Description Notes team_id str The ID of the incident team. body IncidentTeamUpdateRequest Incident Team Payload. Return type IncidentTeamResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.IncidentTeamsApi"},{"location":"v2/IncidentTeamsApi/#datadog_api_clientv2incidentteamsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_team POST /api/v2/teams Create a new incident team delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team list_incident_teams GET /api/v2/teams Get a list of all incident teams update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team","title":"datadog_api_client.v2.IncidentTeamsApi"},{"location":"v2/IncidentTeamsApi/#create_incident_team","text":"IncidentTeamResponse create_incident_team(body) Create a new incident team Creates a new incident team.","title":"create_incident_team"},{"location":"v2/IncidentTeamsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) body = IncidentTeamCreateRequest( data=IncidentTeamCreateData( attributes=IncidentTeamCreateAttributes( name=\"team name\", ), relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamCreateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Create a new incident team api_response = api_instance.create_incident_team(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->create_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters","text":"Name Type Description Notes body IncidentTeamCreateRequest Incident Team Payload.","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type","text":"IncidentTeamResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details","text":"Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#delete_incident_team","text":"delete_incident_team(team_id) Delete an existing incident team Deletes an existing incident team.","title":"delete_incident_team"},{"location":"v2/IncidentTeamsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. # example passing only required values which don't have defaults set try: # Delete an existing incident team api_instance.delete_incident_team(team_id) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->delete_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_1","text":"Name Type Description Notes team_id str The ID of the incident team.","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#get_incident_team","text":"IncidentTeamResponse get_incident_team(team_id) Get details of an incident team Get details of an incident team. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams.","title":"get_incident_team"},{"location":"v2/IncidentTeamsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_2","text":"Name Type Description Notes team_id str The ID of the incident team. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional]","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_2","text":"IncidentTeamResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#list_incident_teams","text":"IncidentTeamsResponse list_incident_teams() Get a list of all incident teams Get all incident teams for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams.","title":"list_incident_teams"},{"location":"v2/IncidentTeamsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_teams\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleTeamName\" # str | A search query that filters teams by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident teams api_response = api_instance.list_incident_teams(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->list_incident_teams: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_3","text":"Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters teams by name. [optional]","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_3","text":"IncidentTeamsResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#update_incident_team","text":"IncidentTeamResponse update_incident_team(team_id, body) Update an existing incident team Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update.","title":"update_incident_team"},{"location":"v2/IncidentTeamsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. body = IncidentTeamUpdateRequest( data=IncidentTeamUpdateData( attributes=IncidentTeamUpdateAttributes( name=\"team name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamUpdateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Update an existing incident team api_response = api_instance.update_incident_team(team_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->update_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_4","text":"Name Type Description Notes team_id str The ID of the incident team. body IncidentTeamUpdateRequest Incident Team Payload.","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_4","text":"IncidentTeamResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsResponse/","text":"IncidentTeamsResponse Response with a list of incident team payloads. Properties Name Type Description Notes data [IncidentTeamResponseData] An array of incident teams. included [IncidentTeamIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamsResponse"},{"location":"v2/IncidentTeamsResponse/#incidentteamsresponse","text":"Response with a list of incident team payloads.","title":"IncidentTeamsResponse"},{"location":"v2/IncidentTeamsResponse/#properties","text":"Name Type Description Notes data [IncidentTeamResponseData] An array of incident teams. included [IncidentTeamIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellCreateAttributes/","text":"IncidentTimelineCellCreateAttributes The timeline cell's attributes for a create request. Properties Name Type Description Notes important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False cell_type IncidentTimelineCellMarkdownContentType [optional] content IncidentTimelineCellMarkdownCreateAttributesContent [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellCreateAttributes"},{"location":"v2/IncidentTimelineCellCreateAttributes/#incidenttimelinecellcreateattributes","text":"The timeline cell's attributes for a create request.","title":"IncidentTimelineCellCreateAttributes"},{"location":"v2/IncidentTimelineCellCreateAttributes/#properties","text":"Name Type Description Notes important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False cell_type IncidentTimelineCellMarkdownContentType [optional] content IncidentTimelineCellMarkdownCreateAttributesContent [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellMarkdownContentType/","text":"IncidentTimelineCellMarkdownContentType Type of the Markdown timeline cell. Properties Name Type Description Notes value str Type of the Markdown timeline cell. defaults to \"markdown\", must be one of [\"markdown\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellMarkdownContentType"},{"location":"v2/IncidentTimelineCellMarkdownContentType/#incidenttimelinecellmarkdowncontenttype","text":"Type of the Markdown timeline cell.","title":"IncidentTimelineCellMarkdownContentType"},{"location":"v2/IncidentTimelineCellMarkdownContentType/#properties","text":"Name Type Description Notes value str Type of the Markdown timeline cell. defaults to \"markdown\", must be one of [\"markdown\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributes/","text":"IncidentTimelineCellMarkdownCreateAttributes Timeline cell data for Markdown timeline cells for a create request. Properties Name Type Description Notes cell_type IncidentTimelineCellMarkdownContentType content IncidentTimelineCellMarkdownCreateAttributesContent important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellMarkdownCreateAttributes"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributes/#incidenttimelinecellmarkdowncreateattributes","text":"Timeline cell data for Markdown timeline cells for a create request.","title":"IncidentTimelineCellMarkdownCreateAttributes"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributes/#properties","text":"Name Type Description Notes cell_type IncidentTimelineCellMarkdownContentType content IncidentTimelineCellMarkdownCreateAttributesContent important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributesContent/","text":"IncidentTimelineCellMarkdownCreateAttributesContent The Markdown timeline cell contents. Properties Name Type Description Notes content str The Markdown content of the cell. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellMarkdownCreateAttributesContent"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributesContent/#incidenttimelinecellmarkdowncreateattributescontent","text":"The Markdown timeline cell contents.","title":"IncidentTimelineCellMarkdownCreateAttributesContent"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributesContent/#properties","text":"Name Type Description Notes content str The Markdown content of the cell. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentType/","text":"IncidentType Incident resource type. Properties Name Type Description Notes value str Incident resource type. defaults to \"incidents\", must be one of [\"incidents\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentType"},{"location":"v2/IncidentType/#incidenttype","text":"Incident resource type.","title":"IncidentType"},{"location":"v2/IncidentType/#properties","text":"Name Type Description Notes value str Incident resource type. defaults to \"incidents\", must be one of [\"incidents\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateAttributes/","text":"IncidentUpdateAttributes The incident's attributes for an update request. Properties Name Type Description Notes customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to update selections. [optional] notification_handles [str] Notification handles that will be notified of the incident during update. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] title str The title of the incident, which summarizes what happened. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateAttributes"},{"location":"v2/IncidentUpdateAttributes/#incidentupdateattributes","text":"The incident's attributes for an update request.","title":"IncidentUpdateAttributes"},{"location":"v2/IncidentUpdateAttributes/#properties","text":"Name Type Description Notes customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to update selections. [optional] notification_handles [str] Notification handles that will be notified of the incident during update. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] title str The title of the incident, which summarizes what happened. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateData/","text":"IncidentUpdateData Incident data for an update request. Properties Name Type Description Notes id str The team's ID. type IncidentType attributes IncidentUpdateAttributes [optional] relationships IncidentUpdateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateData"},{"location":"v2/IncidentUpdateData/#incidentupdatedata","text":"Incident data for an update request.","title":"IncidentUpdateData"},{"location":"v2/IncidentUpdateData/#properties","text":"Name Type Description Notes id str The team's ID. type IncidentType attributes IncidentUpdateAttributes [optional] relationships IncidentUpdateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateRelationships/","text":"IncidentUpdateRelationships The incident's relationships for an update request. Properties Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateRelationships"},{"location":"v2/IncidentUpdateRelationships/#incidentupdaterelationships","text":"The incident's relationships for an update request.","title":"IncidentUpdateRelationships"},{"location":"v2/IncidentUpdateRelationships/#properties","text":"Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateRequest/","text":"IncidentUpdateRequest Update request for an incident. Properties Name Type Description Notes data IncidentUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateRequest"},{"location":"v2/IncidentUpdateRequest/#incidentupdaterequest","text":"Update request for an incident.","title":"IncidentUpdateRequest"},{"location":"v2/IncidentUpdateRequest/#properties","text":"Name Type Description Notes data IncidentUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentsApi/","text":"datadog_api_client.v2.IncidentsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident POST /api/v2/incidents Create an incident delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident list_incidents GET /api/v2/incidents Get a list of incidents update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident create_incident IncidentResponse create_incident(body) Create an incident Create an incident. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) body = IncidentCreateRequest( data=IncidentCreateData( attributes=IncidentCreateAttributes( customer_impacted=False, fields={ \"key\": IncidentFieldAttributes(), }, initial_timeline_cells=[ IncidentTimelineCellCreateAttributes(), ], notification_handles=[ \"@test.user@test.com\", ], title=\"A test incident title\", ), relationships=IncidentCreateRelationships( commander=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentCreateRequest | Incident payload. # example passing only required values which don't have defaults set try: # Create an incident api_response = api_instance.create_incident(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->create_incident: %s\\n\" % e) Parameters Name Type Description Notes body IncidentCreateRequest Incident payload. Return type IncidentResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_incident delete_incident(incident_id) Delete an existing incident Deletes an existing incident from the users organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. # example passing only required values which don't have defaults set try: # Delete an existing incident api_instance.delete_incident(incident_id) except ApiException as e: print(\"Exception when calling IncidentsApi->delete_incident: %s\\n\" % e) Parameters Name Type Description Notes incident_id str The UUID the incident. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident IncidentResponse get_incident(incident_id) Get the details of an incident Get the details of an incident by incident_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get the details of an incident api_response = api_instance.get_incident(incident_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get the details of an incident api_response = api_instance.get_incident(incident_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e) Parameters Name Type Description Notes incident_id str The UUID the incident. include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional] Return type IncidentResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_incidents IncidentsResponse list_incidents() Get a list of incidents Get all incidents for the user's organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incidents\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # Get a list of incidents api_response = api_instance.list_incidents(include=include, page_size=page_size, page_offset=page_offset) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->list_incidents: %s\\n\" % e) Parameters Name Type Description Notes include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 Return type IncidentsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_incident IncidentResponse update_incident(incident_id, body) Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. body = IncidentUpdateRequest( data=IncidentUpdateData( attributes=IncidentUpdateAttributes( customer_impact_end=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impact_scope=\"Example customer impact scope\", customer_impact_start=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impacted=False, detected=dateutil_parser('1970-01-01T00:00:00.00Z'), fields={ \"key\": IncidentFieldAttributes(), }, notification_handles=[ \"@test.user@test.com\", ], resolved=dateutil_parser('1970-01-01T00:00:00.00Z'), title=\"A test incident title\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentUpdateRelationships( commander_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), created_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), integrations=RelationshipToIncidentIntegrationMetadatas( data=[ RelationshipToIncidentIntegrationMetadataData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentIntegrationMetadataType(\"incident_integration_metadata\"), ), ], ), last_modified_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), postmortem=RelationshipToIncidentPostmortem( data=RelationshipToIncidentPostmortemData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentPostmortemType(\"incident_postmortems\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentUpdateRequest | Incident Payload. # example passing only required values which don't have defaults set try: # Update an existing incident api_response = api_instance.update_incident(incident_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->update_incident: %s\\n\" % e) Parameters Name Type Description Notes incident_id str The UUID the incident. body IncidentUpdateRequest Incident Payload. Return type IncidentResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.IncidentsApi"},{"location":"v2/IncidentsApi/#datadog_api_clientv2incidentsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident POST /api/v2/incidents Create an incident delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident list_incidents GET /api/v2/incidents Get a list of incidents update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident","title":"datadog_api_client.v2.IncidentsApi"},{"location":"v2/IncidentsApi/#create_incident","text":"IncidentResponse create_incident(body) Create an incident Create an incident.","title":"create_incident"},{"location":"v2/IncidentsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) body = IncidentCreateRequest( data=IncidentCreateData( attributes=IncidentCreateAttributes( customer_impacted=False, fields={ \"key\": IncidentFieldAttributes(), }, initial_timeline_cells=[ IncidentTimelineCellCreateAttributes(), ], notification_handles=[ \"@test.user@test.com\", ], title=\"A test incident title\", ), relationships=IncidentCreateRelationships( commander=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentCreateRequest | Incident payload. # example passing only required values which don't have defaults set try: # Create an incident api_response = api_instance.create_incident(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->create_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters","text":"Name Type Description Notes body IncidentCreateRequest Incident payload.","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type","text":"IncidentResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details","text":"Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#delete_incident","text":"delete_incident(incident_id) Delete an existing incident Deletes an existing incident from the users organization.","title":"delete_incident"},{"location":"v2/IncidentsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. # example passing only required values which don't have defaults set try: # Delete an existing incident api_instance.delete_incident(incident_id) except ApiException as e: print(\"Exception when calling IncidentsApi->delete_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_1","text":"Name Type Description Notes incident_id str The UUID the incident.","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#get_incident","text":"IncidentResponse get_incident(incident_id) Get the details of an incident Get the details of an incident by incident_id .","title":"get_incident"},{"location":"v2/IncidentsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get the details of an incident api_response = api_instance.get_incident(incident_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get the details of an incident api_response = api_instance.get_incident(incident_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_2","text":"Name Type Description Notes incident_id str The UUID the incident. include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional]","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_2","text":"IncidentResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#list_incidents","text":"IncidentsResponse list_incidents() Get a list of incidents Get all incidents for the user's organization.","title":"list_incidents"},{"location":"v2/IncidentsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incidents\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # Get a list of incidents api_response = api_instance.list_incidents(include=include, page_size=page_size, page_offset=page_offset) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->list_incidents: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_3","text":"Name Type Description Notes include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_3","text":"IncidentsResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#update_incident","text":"IncidentResponse update_incident(incident_id, body) Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update.","title":"update_incident"},{"location":"v2/IncidentsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. body = IncidentUpdateRequest( data=IncidentUpdateData( attributes=IncidentUpdateAttributes( customer_impact_end=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impact_scope=\"Example customer impact scope\", customer_impact_start=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impacted=False, detected=dateutil_parser('1970-01-01T00:00:00.00Z'), fields={ \"key\": IncidentFieldAttributes(), }, notification_handles=[ \"@test.user@test.com\", ], resolved=dateutil_parser('1970-01-01T00:00:00.00Z'), title=\"A test incident title\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentUpdateRelationships( commander_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), created_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), integrations=RelationshipToIncidentIntegrationMetadatas( data=[ RelationshipToIncidentIntegrationMetadataData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentIntegrationMetadataType(\"incident_integration_metadata\"), ), ], ), last_modified_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), postmortem=RelationshipToIncidentPostmortem( data=RelationshipToIncidentPostmortemData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentPostmortemType(\"incident_postmortems\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentUpdateRequest | Incident Payload. # example passing only required values which don't have defaults set try: # Update an existing incident api_response = api_instance.update_incident(incident_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->update_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_4","text":"Name Type Description Notes incident_id str The UUID the incident. body IncidentUpdateRequest Incident Payload.","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_4","text":"IncidentResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsResponse/","text":"IncidentsResponse Response with a list of incidents. Properties Name Type Description Notes data [IncidentResponseData] An array of incidents. included [IncidentResponseIncludedItem] Included related resources that the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentsResponse"},{"location":"v2/IncidentsResponse/#incidentsresponse","text":"Response with a list of incidents.","title":"IncidentsResponse"},{"location":"v2/IncidentsResponse/#properties","text":"Name Type Description Notes data [IncidentResponseData] An array of incidents. included [IncidentResponseIncludedItem] Included related resources that the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/KeyManagementApi/","text":"datadog_api_client.v2.KeyManagementApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v2/api_keys Create an API key create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key 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 GET /api/v2/api_keys/{api_key_id} Get API key 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 GET /api/v2/api_keys Get all API keys list_application_keys GET /api/v2/application_keys Get all application keys list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key 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 APIKeyResponse create_api_key(body) Create an API key Create an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = APIKeyCreateRequest( data=APIKeyCreateData( attributes=APIKeyCreateAttributes( name=\"API Key for submitting metrics\", ), type=APIKeysType(\"api_keys\"), ), ) # APIKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e) Parameters Name Type Description Notes body APIKeyCreateRequest Return type APIKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_current_user_application_key ApplicationKeyResponse create_current_user_application_key(body) Create an application key for current user Create an application key for current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKeyCreateRequest( data=ApplicationKeyCreateData( attributes=ApplicationKeyCreateAttributes( name=\"Application Key for submitting metrics\", ), type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an application key for current user api_response = api_instance.create_current_user_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes body ApplicationKeyCreateRequest Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_api_key delete_api_key(api_key_id) Delete an API key Delete an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. # example passing only required values which don't have defaults set try: # Delete an API key api_instance.delete_api_key(api_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e) Parameters Name Type Description Notes api_key_id str The ID of the API key. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_application_key delete_application_key(app_key_id) Delete an application key Delete an application key Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key api_instance.delete_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_current_user_application_key delete_current_user_application_key(app_key_id) Delete an application key owned by current user Delete an application key owned by current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key owned by current user api_instance.delete_current_user_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_key APIKeyResponse get_api_key(api_key_id) Get API key Get an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(api_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get API key api_response = api_instance.get_api_key(api_key_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) Parameters Name Type Description Notes api_key_id str The ID of the API key. include str 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 APIKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_current_user_application_key ApplicationKeyResponse get_current_user_application_key(app_key_id) Get one application key owned by current user Get an application key owned by current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Get one application key owned by current user api_response = api_instance.get_current_user_application_key(app_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_api_keys APIKeysResponse list_api_keys() Get all API keys List all API keys available for your account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = APIKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter API keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or before the specified date. (optional) filter_modified_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or after the specified date. (optional) filter_modified_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or before the specified date. (optional) include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all API keys api_response = api_instance.list_api_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end, filter_modified_at_start=filter_modified_at_start, filter_modified_at_end=filter_modified_at_end, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter API keys by the specified string. [optional] filter_created_at_start str Only include API keys created on or after the specified date. [optional] filter_created_at_end str Only include API keys created on or before the specified date. [optional] filter_modified_at_start str Only include API keys modified on or after the specified date. [optional] filter_modified_at_end str Only include API keys modified on or before the specified date. [optional] include str 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 APIKeysResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_application_keys ListApplicationKeysResponse list_application_keys() Get all application keys List all application keys available for your org Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys api_response = api_instance.list_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional] Return type ListApplicationKeysResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_current_user_application_keys ListApplicationKeysResponse list_current_user_application_keys() Get all application keys owned by current user List all application keys available for current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys owned by current user api_response = api_instance.list_current_user_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_current_user_application_keys: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional] Return type ListApplicationKeysResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_api_key APIKeyResponse update_api_key(api_key_id, body) Edit an API key Update an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. body = APIKeyUpdateRequest( data=APIKeyUpdateData( attributes=APIKeyUpdateAttributes( name=\"API Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=APIKeysType(\"api_keys\"), ), ) # APIKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(api_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e) Parameters Name Type Description Notes api_key_id str The ID of the API key. body APIKeyUpdateRequest Return type APIKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_application_key ApplicationKeyResponse update_application_key(app_key_id, body) Edit an application key Edit an application key Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_current_user_application_key ApplicationKeyResponse update_current_user_application_key(app_key_id, body) Edit an application key owned by current user Edit an application key owned by current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key owned by current user api_response = api_instance.update_current_user_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.KeyManagementApi"},{"location":"v2/KeyManagementApi/#datadog_api_clientv2keymanagementapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v2/api_keys Create an API key create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key 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 GET /api/v2/api_keys/{api_key_id} Get API key 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 GET /api/v2/api_keys Get all API keys list_application_keys GET /api/v2/application_keys Get all application keys list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key update_current_user_application_key PATCH /api/v2/current_user/application_keys/{app_key_id} Edit an application key owned by current user","title":"datadog_api_client.v2.KeyManagementApi"},{"location":"v2/KeyManagementApi/#create_api_key","text":"APIKeyResponse create_api_key(body) Create an API key Create an API key.","title":"create_api_key"},{"location":"v2/KeyManagementApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = APIKeyCreateRequest( data=APIKeyCreateData( attributes=APIKeyCreateAttributes( name=\"API Key for submitting metrics\", ), type=APIKeysType(\"api_keys\"), ), ) # APIKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters","text":"Name Type Description Notes body APIKeyCreateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type","text":"APIKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details","text":"Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#create_current_user_application_key","text":"ApplicationKeyResponse create_current_user_application_key(body) Create an application key for current user Create an application key for current user","title":"create_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKeyCreateRequest( data=ApplicationKeyCreateData( attributes=ApplicationKeyCreateAttributes( name=\"Application Key for submitting metrics\", ), type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an application key for current user api_response = api_instance.create_current_user_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_1","text":"Name Type Description Notes body ApplicationKeyCreateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_1","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_1","text":"Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#delete_api_key","text":"delete_api_key(api_key_id) Delete an API key Delete an API key.","title":"delete_api_key"},{"location":"v2/KeyManagementApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. # example passing only required values which don't have defaults set try: # Delete an API key api_instance.delete_api_key(api_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_2","text":"Name Type Description Notes api_key_id str The ID of the API key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_2","text":"void (empty response body)","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_2","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#delete_application_key","text":"delete_application_key(app_key_id) Delete an application key Delete an application key","title":"delete_application_key"},{"location":"v2/KeyManagementApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key api_instance.delete_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_3","text":"Name Type Description Notes app_key_id str The ID of the application key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_3","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#delete_current_user_application_key","text":"delete_current_user_application_key(app_key_id) Delete an application key owned by current user Delete an application key owned by current user","title":"delete_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key owned by current user api_instance.delete_current_user_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_4","text":"Name Type Description Notes app_key_id str The ID of the application key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_4","text":"void (empty response body)","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_4","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#get_api_key","text":"APIKeyResponse get_api_key(api_key_id) Get API key Get an API key.","title":"get_api_key"},{"location":"v2/KeyManagementApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(api_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get API key api_response = api_instance.get_api_key(api_key_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_5","text":"Name Type Description Notes api_key_id str The ID of the API key. include str Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_5","text":"APIKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#get_current_user_application_key","text":"ApplicationKeyResponse get_current_user_application_key(app_key_id) Get one application key owned by current user Get an application key owned by current user","title":"get_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Get one application key owned by current user api_response = api_instance.get_current_user_application_key(app_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_6","text":"Name Type Description Notes app_key_id str The ID of the application key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_6","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#list_api_keys","text":"APIKeysResponse list_api_keys() Get all API keys List all API keys available for your account.","title":"list_api_keys"},{"location":"v2/KeyManagementApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = APIKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter API keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or before the specified date. (optional) filter_modified_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or after the specified date. (optional) filter_modified_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or before the specified date. (optional) include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all API keys api_response = api_instance.list_api_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end, filter_modified_at_start=filter_modified_at_start, filter_modified_at_end=filter_modified_at_end, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_7","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter API keys by the specified string. [optional] filter_created_at_start str Only include API keys created on or after the specified date. [optional] filter_created_at_end str Only include API keys created on or before the specified date. [optional] filter_modified_at_start str Only include API keys modified on or after the specified date. [optional] filter_modified_at_end str Only include API keys modified on or before the specified date. [optional] include str Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_7","text":"APIKeysResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#list_application_keys","text":"ListApplicationKeysResponse list_application_keys() Get all application keys List all application keys available for your org","title":"list_application_keys"},{"location":"v2/KeyManagementApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys api_response = api_instance.list_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_8","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_8","text":"ListApplicationKeysResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#list_current_user_application_keys","text":"ListApplicationKeysResponse list_current_user_application_keys() Get all application keys owned by current user List all application keys available for current user","title":"list_current_user_application_keys"},{"location":"v2/KeyManagementApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys owned by current user api_response = api_instance.list_current_user_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_current_user_application_keys: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_9","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_9","text":"ListApplicationKeysResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_9","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#update_api_key","text":"APIKeyResponse update_api_key(api_key_id, body) Edit an API key Update an API key.","title":"update_api_key"},{"location":"v2/KeyManagementApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. body = APIKeyUpdateRequest( data=APIKeyUpdateData( attributes=APIKeyUpdateAttributes( name=\"API Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=APIKeysType(\"api_keys\"), ), ) # APIKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(api_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_10","text":"Name Type Description Notes api_key_id str The ID of the API key. body APIKeyUpdateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_10","text":"APIKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_10","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#update_application_key","text":"ApplicationKeyResponse update_application_key(app_key_id, body) Edit an application key Edit an application key","title":"update_application_key"},{"location":"v2/KeyManagementApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_11","text":"Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_11","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_11","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#update_current_user_application_key","text":"ApplicationKeyResponse update_current_user_application_key(app_key_id, body) Edit an application key owned by current user Edit an application key owned by current user","title":"update_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_12","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key owned by current user api_response = api_instance.update_current_user_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_12","text":"Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_12","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_12","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_12","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_12","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/ListApplicationKeysResponse/","text":"ListApplicationKeysResponse Response for a list of application keys. Properties Name Type Description Notes data [PartialApplicationKey] Array of application keys. [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ListApplicationKeysResponse"},{"location":"v2/ListApplicationKeysResponse/#listapplicationkeysresponse","text":"Response for a list of application keys.","title":"ListApplicationKeysResponse"},{"location":"v2/ListApplicationKeysResponse/#properties","text":"Name Type Description Notes data [PartialApplicationKey] Array of application keys. [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Log/","text":"Log Object description of a log after being processed and stored by Datadog. Properties Name Type Description Notes attributes LogAttributes [optional] id str Unique ID of the Log. [optional] type LogType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Log"},{"location":"v2/Log/#log","text":"Object description of a log after being processed and stored by Datadog.","title":"Log"},{"location":"v2/Log/#properties","text":"Name Type Description Notes attributes LogAttributes [optional] id str Unique ID of the Log. [optional] type LogType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogAttributes/","text":"LogAttributes JSON object containing all log attributes and their associated values. Properties Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 str Status of the message associated with your log. [optional] tags [str] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogAttributes"},{"location":"v2/LogAttributes/#logattributes","text":"JSON object containing all log attributes and their associated values.","title":"LogAttributes"},{"location":"v2/LogAttributes/#properties","text":"Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 str Status of the message associated with your log. [optional] tags [str] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogType/","text":"LogType Type of the event. Properties Name Type Description Notes value str Type of the event. defaults to \"log\", must be one of [\"log\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogType"},{"location":"v2/LogType/#logtype","text":"Type of the event.","title":"LogType"},{"location":"v2/LogType/#properties","text":"Name Type Description Notes value str Type of the event. defaults to \"log\", must be one of [\"log\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucket/","text":"LogsAggregateBucket A bucket values Properties Name Type Description Notes by {str: (str,)} The key, value pairs for each group by [optional] computes {str: (LogsAggregateBucketValue,)} A map of the metric name -> value for regular compute or list of values for a timeseries [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucket"},{"location":"v2/LogsAggregateBucket/#logsaggregatebucket","text":"A bucket values","title":"LogsAggregateBucket"},{"location":"v2/LogsAggregateBucket/#properties","text":"Name Type Description Notes by {str: (str,)} The key, value pairs for each group by [optional] computes {str: (LogsAggregateBucketValue,)} A map of the metric name -> value for regular compute or list of values for a timeseries [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucketValue/","text":"LogsAggregateBucketValue A bucket value, can be either a timeseries or a single value Properties Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucketValue"},{"location":"v2/LogsAggregateBucketValue/#logsaggregatebucketvalue","text":"A bucket value, can be either a timeseries or a single value","title":"LogsAggregateBucketValue"},{"location":"v2/LogsAggregateBucketValue/#properties","text":"Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucketValueTimeseries/","text":"LogsAggregateBucketValueTimeseries A timeseries array Properties Name Type Description Notes value [LogsAggregateBucketValueTimeseriesPoint] A timeseries array [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucketValueTimeseries"},{"location":"v2/LogsAggregateBucketValueTimeseries/#logsaggregatebucketvaluetimeseries","text":"A timeseries array","title":"LogsAggregateBucketValueTimeseries"},{"location":"v2/LogsAggregateBucketValueTimeseries/#properties","text":"Name Type Description Notes value [LogsAggregateBucketValueTimeseriesPoint] A timeseries array [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucketValueTimeseriesPoint/","text":"LogsAggregateBucketValueTimeseriesPoint A timeseries point Properties Name Type Description Notes time str The time value for this point [optional] value float The value for this point [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucketValueTimeseriesPoint"},{"location":"v2/LogsAggregateBucketValueTimeseriesPoint/#logsaggregatebucketvaluetimeseriespoint","text":"A timeseries point","title":"LogsAggregateBucketValueTimeseriesPoint"},{"location":"v2/LogsAggregateBucketValueTimeseriesPoint/#properties","text":"Name Type Description Notes time str The time value for this point [optional] value float The value for this point [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateRequest/","text":"LogsAggregateRequest The object sent with the request to retrieve a list of logs from your organization. Properties Name Type Description Notes compute [LogsCompute] The list of metrics or timeseries to compute for the retrieved buckets. [optional] filter LogsQueryFilter [optional] group_by [LogsGroupBy] The rules for the group by [optional] options LogsQueryOptions [optional] page LogsAggregateRequestPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateRequest"},{"location":"v2/LogsAggregateRequest/#logsaggregaterequest","text":"The object sent with the request to retrieve a list of logs from your organization.","title":"LogsAggregateRequest"},{"location":"v2/LogsAggregateRequest/#properties","text":"Name Type Description Notes compute [LogsCompute] The list of metrics or timeseries to compute for the retrieved buckets. [optional] filter LogsQueryFilter [optional] group_by [LogsGroupBy] The rules for the group by [optional] options LogsQueryOptions [optional] page LogsAggregateRequestPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateRequestPage/","text":"LogsAggregateRequestPage Paging settings Properties Name Type Description Notes cursor str The returned paging point to use to get the next results [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateRequestPage"},{"location":"v2/LogsAggregateRequestPage/#logsaggregaterequestpage","text":"Paging settings","title":"LogsAggregateRequestPage"},{"location":"v2/LogsAggregateRequestPage/#properties","text":"Name Type Description Notes cursor str The returned paging point to use to get the next results [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateResponse/","text":"LogsAggregateResponse The response object for the logs aggregate API endpoint Properties Name Type Description Notes data LogsAggregateResponseData [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateResponse"},{"location":"v2/LogsAggregateResponse/#logsaggregateresponse","text":"The response object for the logs aggregate API endpoint","title":"LogsAggregateResponse"},{"location":"v2/LogsAggregateResponse/#properties","text":"Name Type Description Notes data LogsAggregateResponseData [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateResponseData/","text":"LogsAggregateResponseData The query results Properties Name Type Description Notes buckets [LogsAggregateBucket] The list of matching buckets, one item per bucket [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateResponseData"},{"location":"v2/LogsAggregateResponseData/#logsaggregateresponsedata","text":"The query results","title":"LogsAggregateResponseData"},{"location":"v2/LogsAggregateResponseData/#properties","text":"Name Type Description Notes buckets [LogsAggregateBucket] The list of matching buckets, one item per bucket [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateResponseStatus/","text":"LogsAggregateResponseStatus The status of the response Properties Name Type Description Notes value str The status of the response must be one of [\"done\", \"timeout\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateResponseStatus"},{"location":"v2/LogsAggregateResponseStatus/#logsaggregateresponsestatus","text":"The status of the response","title":"LogsAggregateResponseStatus"},{"location":"v2/LogsAggregateResponseStatus/#properties","text":"Name Type Description Notes value str The status of the response must be one of [\"done\", \"timeout\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateSort/","text":"LogsAggregateSort A sort rule Properties Name Type Description Notes aggregation LogsAggregationFunction [optional] metric str The metric to sort by (only used for `type=measure`) [optional] order LogsSortOrder [optional] type LogsAggregateSortType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateSort"},{"location":"v2/LogsAggregateSort/#logsaggregatesort","text":"A sort rule","title":"LogsAggregateSort"},{"location":"v2/LogsAggregateSort/#properties","text":"Name Type Description Notes aggregation LogsAggregationFunction [optional] metric str The metric to sort by (only used for `type=measure`) [optional] order LogsSortOrder [optional] type LogsAggregateSortType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateSortType/","text":"LogsAggregateSortType The type of sorting algorithm Properties Name Type Description Notes value str The type of sorting algorithm defaults to \"alphabetical\", must be one of [\"alphabetical\", \"measure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateSortType"},{"location":"v2/LogsAggregateSortType/#logsaggregatesorttype","text":"The type of sorting algorithm","title":"LogsAggregateSortType"},{"location":"v2/LogsAggregateSortType/#properties","text":"Name Type Description Notes value str The type of sorting algorithm defaults to \"alphabetical\", must be one of [\"alphabetical\", \"measure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregationFunction/","text":"LogsAggregationFunction An aggregation function Properties Name Type Description Notes value str An aggregation function must be one of [\"count\", \"cardinality\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregationFunction"},{"location":"v2/LogsAggregationFunction/#logsaggregationfunction","text":"An aggregation function","title":"LogsAggregationFunction"},{"location":"v2/LogsAggregationFunction/#properties","text":"Name Type Description Notes value str An aggregation function must be one of [\"count\", \"cardinality\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsApi/","text":"datadog_api_client.v2.LogsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events list_logs POST /api/v2/logs/events/search Search logs list_logs_get GET /api/v2/logs/events Get a list of logs aggregate_logs LogsAggregateResponse aggregate_logs(body) Aggregate events The API endpoint to aggregate events into buckets and compute metrics and timeseries. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsAggregateRequest( compute=[ LogsCompute( aggregation=LogsAggregationFunction(\"pc90\"), interval=\"5m\", metric=\"@duration\", type=LogsComputeType(\"total\"), ), ], filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), group_by=[ LogsGroupBy( facet=\"host\", histogram=LogsGroupByHistogram( interval=10, max=100, min=50, ), limit=10, missing=LogsGroupByMissing(), sort=LogsAggregateSort( aggregation=LogsAggregationFunction(\"pc90\"), metric=\"@duration\", order=LogsSortOrder(\"asc\"), type=LogsAggregateSortType(\"alphabetical\"), ), total=LogsGroupByTotal(), ), ], options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsAggregateRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", ), ) # LogsAggregateRequest | # example passing only required values which don't have defaults set try: # Aggregate events api_response = api_instance.aggregate_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->aggregate_logs: %s\\n\" % e) Parameters Name Type Description Notes body LogsAggregateRequest Return type LogsAggregateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs LogsListResponse list_logs() Search logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to build complex logs filtering and search. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=LogsSort(\"timestamp\"), ) # LogsListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Search logs api_response = api_instance.list_logs(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e) Parameters Name Type Description Notes body LogsListRequest [optional] Return type LogsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_get LogsListResponse list_logs_get() Get a list of logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to see your latest logs. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) filter_query = \"@datacenter:us @role:db\" # str | Search query following logs syntax. (optional) filter_index = \"main\" # str | For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | Minimum timestamp for requested logs. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | Maximum timestamp for requested logs. (optional) sort = LogsSort(\"timestamp\") # LogsSort | Order of logs in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | List following results with a cursor provided in the previous query. (optional) page_limit = 25 # int | Maximum number of logs in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a list of logs api_response = api_instance.list_logs_get(filter_query=filter_query, filter_index=filter_index, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs_get: %s\\n\" % e) Parameters Name Type Description Notes filter_query str Search query following logs syntax. [optional] filter_index str For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes [optional] filter_from datetime Minimum timestamp for requested logs. [optional] filter_to datetime Maximum timestamp for requested logs. [optional] sort LogsSort Order of logs in results. [optional] page_cursor str List following results with a cursor provided in the previous query. [optional] page_limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10 Return type LogsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.LogsApi"},{"location":"v2/LogsApi/#datadog_api_clientv2logsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events list_logs POST /api/v2/logs/events/search Search logs list_logs_get GET /api/v2/logs/events Get a list of logs","title":"datadog_api_client.v2.LogsApi"},{"location":"v2/LogsApi/#aggregate_logs","text":"LogsAggregateResponse aggregate_logs(body) Aggregate events The API endpoint to aggregate events into buckets and compute metrics and timeseries.","title":"aggregate_logs"},{"location":"v2/LogsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsAggregateRequest( compute=[ LogsCompute( aggregation=LogsAggregationFunction(\"pc90\"), interval=\"5m\", metric=\"@duration\", type=LogsComputeType(\"total\"), ), ], filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), group_by=[ LogsGroupBy( facet=\"host\", histogram=LogsGroupByHistogram( interval=10, max=100, min=50, ), limit=10, missing=LogsGroupByMissing(), sort=LogsAggregateSort( aggregation=LogsAggregationFunction(\"pc90\"), metric=\"@duration\", order=LogsSortOrder(\"asc\"), type=LogsAggregateSortType(\"alphabetical\"), ), total=LogsGroupByTotal(), ), ], options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsAggregateRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", ), ) # LogsAggregateRequest | # example passing only required values which don't have defaults set try: # Aggregate events api_response = api_instance.aggregate_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->aggregate_logs: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsApi/#parameters","text":"Name Type Description Notes body LogsAggregateRequest","title":"Parameters"},{"location":"v2/LogsApi/#return-type","text":"LogsAggregateResponse","title":"Return type"},{"location":"v2/LogsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsApi/#list_logs","text":"LogsListResponse list_logs() Search logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to build complex logs filtering and search. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives","title":"list_logs"},{"location":"v2/LogsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=LogsSort(\"timestamp\"), ) # LogsListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Search logs api_response = api_instance.list_logs(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsApi/#parameters_1","text":"Name Type Description Notes body LogsListRequest [optional]","title":"Parameters"},{"location":"v2/LogsApi/#return-type_1","text":"LogsListResponse","title":"Return type"},{"location":"v2/LogsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsApi/#list_logs_get","text":"LogsListResponse list_logs_get() Get a list of logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to see your latest logs. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives","title":"list_logs_get"},{"location":"v2/LogsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) filter_query = \"@datacenter:us @role:db\" # str | Search query following logs syntax. (optional) filter_index = \"main\" # str | For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | Minimum timestamp for requested logs. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | Maximum timestamp for requested logs. (optional) sort = LogsSort(\"timestamp\") # LogsSort | Order of logs in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | List following results with a cursor provided in the previous query. (optional) page_limit = 25 # int | Maximum number of logs in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a list of logs api_response = api_instance.list_logs_get(filter_query=filter_query, filter_index=filter_index, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs_get: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsApi/#parameters_2","text":"Name Type Description Notes filter_query str Search query following logs syntax. [optional] filter_index str For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes [optional] filter_from datetime Minimum timestamp for requested logs. [optional] filter_to datetime Maximum timestamp for requested logs. [optional] sort LogsSort Order of logs in results. [optional] page_cursor str List following results with a cursor provided in the previous query. [optional] page_limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10","title":"Parameters"},{"location":"v2/LogsApi/#return-type_2","text":"LogsListResponse","title":"Return type"},{"location":"v2/LogsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchive/","text":"LogsArchive The logs archive. Properties Name Type Description Notes data LogsArchiveDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchive"},{"location":"v2/LogsArchive/#logsarchive","text":"The logs archive.","title":"LogsArchive"},{"location":"v2/LogsArchive/#properties","text":"Name Type Description Notes data LogsArchiveDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveAttributes/","text":"LogsArchiveAttributes The attributes associated with the archive. Properties Name Type Description Notes destination LogsArchiveDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] state LogsArchiveState [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveAttributes"},{"location":"v2/LogsArchiveAttributes/#logsarchiveattributes","text":"The attributes associated with the archive.","title":"LogsArchiveAttributes"},{"location":"v2/LogsArchiveAttributes/#properties","text":"Name Type Description Notes destination LogsArchiveDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] state LogsArchiveState [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequest/","text":"LogsArchiveCreateRequest The logs archive. Properties Name Type Description Notes data LogsArchiveCreateRequestDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequest"},{"location":"v2/LogsArchiveCreateRequest/#logsarchivecreaterequest","text":"The logs archive.","title":"LogsArchiveCreateRequest"},{"location":"v2/LogsArchiveCreateRequest/#properties","text":"Name Type Description Notes data LogsArchiveCreateRequestDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequestAttributes/","text":"LogsArchiveCreateRequestAttributes The attributes associated with the archive. Properties Name Type Description Notes destination LogsArchiveCreateRequestDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequestAttributes"},{"location":"v2/LogsArchiveCreateRequestAttributes/#logsarchivecreaterequestattributes","text":"The attributes associated with the archive.","title":"LogsArchiveCreateRequestAttributes"},{"location":"v2/LogsArchiveCreateRequestAttributes/#properties","text":"Name Type Description Notes destination LogsArchiveCreateRequestDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequestDefinition/","text":"LogsArchiveCreateRequestDefinition The definition of an archive. Properties Name Type Description Notes type str The type of the resource. The value should always be archives. defaults to \"archives\" attributes LogsArchiveCreateRequestAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequestDefinition"},{"location":"v2/LogsArchiveCreateRequestDefinition/#logsarchivecreaterequestdefinition","text":"The definition of an archive.","title":"LogsArchiveCreateRequestDefinition"},{"location":"v2/LogsArchiveCreateRequestDefinition/#properties","text":"Name Type Description Notes type str The type of the resource. The value should always be archives. defaults to \"archives\" attributes LogsArchiveCreateRequestAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequestDestination/","text":"LogsArchiveCreateRequestDestination An archive's destination. Properties Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequestDestination"},{"location":"v2/LogsArchiveCreateRequestDestination/#logsarchivecreaterequestdestination","text":"An archive's destination.","title":"LogsArchiveCreateRequestDestination"},{"location":"v2/LogsArchiveCreateRequestDestination/#properties","text":"Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDefinition/","text":"LogsArchiveDefinition The definition of an archive. Properties Name Type Description Notes type str The type of the resource. The value should always be archives. [readonly] defaults to \"archives\" attributes LogsArchiveAttributes [optional] id str The archive ID. optional [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDefinition"},{"location":"v2/LogsArchiveDefinition/#logsarchivedefinition","text":"The definition of an archive.","title":"LogsArchiveDefinition"},{"location":"v2/LogsArchiveDefinition/#properties","text":"Name Type Description Notes type str The type of the resource. The value should always be archives. [readonly] defaults to \"archives\" attributes LogsArchiveAttributes [optional] id str The archive ID. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestination/","text":"LogsArchiveDestination An archive's destination. Properties Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestination"},{"location":"v2/LogsArchiveDestination/#logsarchivedestination","text":"An archive's destination.","title":"LogsArchiveDestination"},{"location":"v2/LogsArchiveDestination/#properties","text":"Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationAzure/","text":"LogsArchiveDestinationAzure The Azure archive destination. Properties Name Type Description Notes container str The container where the archive will be stored. integration LogsArchiveIntegrationAzure storage_account str The associated storage account. type LogsArchiveDestinationAzureType path str The archive path. [optional] region str The region where the archive will be stored. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationAzure"},{"location":"v2/LogsArchiveDestinationAzure/#logsarchivedestinationazure","text":"The Azure archive destination.","title":"LogsArchiveDestinationAzure"},{"location":"v2/LogsArchiveDestinationAzure/#properties","text":"Name Type Description Notes container str The container where the archive will be stored. integration LogsArchiveIntegrationAzure storage_account str The associated storage account. type LogsArchiveDestinationAzureType path str The archive path. [optional] region str The region where the archive will be stored. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationAzureType/","text":"LogsArchiveDestinationAzureType Type of the Azure archive destination. Properties Name Type Description Notes value str Type of the Azure archive destination. defaults to \"azure\", must be one of [\"azure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationAzureType"},{"location":"v2/LogsArchiveDestinationAzureType/#logsarchivedestinationazuretype","text":"Type of the Azure archive destination.","title":"LogsArchiveDestinationAzureType"},{"location":"v2/LogsArchiveDestinationAzureType/#properties","text":"Name Type Description Notes value str Type of the Azure archive destination. defaults to \"azure\", must be one of [\"azure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationGCS/","text":"LogsArchiveDestinationGCS The GCS archive destination. Properties Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationGCS type LogsArchiveDestinationGCSType path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationGCS"},{"location":"v2/LogsArchiveDestinationGCS/#logsarchivedestinationgcs","text":"The GCS archive destination.","title":"LogsArchiveDestinationGCS"},{"location":"v2/LogsArchiveDestinationGCS/#properties","text":"Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationGCS type LogsArchiveDestinationGCSType path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationGCSType/","text":"LogsArchiveDestinationGCSType Type of the GCS archive destination. Properties Name Type Description Notes value str Type of the GCS archive destination. defaults to \"gcs\", must be one of [\"gcs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationGCSType"},{"location":"v2/LogsArchiveDestinationGCSType/#logsarchivedestinationgcstype","text":"Type of the GCS archive destination.","title":"LogsArchiveDestinationGCSType"},{"location":"v2/LogsArchiveDestinationGCSType/#properties","text":"Name Type Description Notes value str Type of the GCS archive destination. defaults to \"gcs\", must be one of [\"gcs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationS3/","text":"LogsArchiveDestinationS3 The S3 archive destination. Properties Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationS3 type LogsArchiveDestinationS3Type path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationS3"},{"location":"v2/LogsArchiveDestinationS3/#logsarchivedestinations3","text":"The S3 archive destination.","title":"LogsArchiveDestinationS3"},{"location":"v2/LogsArchiveDestinationS3/#properties","text":"Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationS3 type LogsArchiveDestinationS3Type path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationS3Type/","text":"LogsArchiveDestinationS3Type Type of the S3 archive destination. Properties Name Type Description Notes value str Type of the S3 archive destination. defaults to \"s3\", must be one of [\"s3\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationS3Type"},{"location":"v2/LogsArchiveDestinationS3Type/#logsarchivedestinations3type","text":"Type of the S3 archive destination.","title":"LogsArchiveDestinationS3Type"},{"location":"v2/LogsArchiveDestinationS3Type/#properties","text":"Name Type Description Notes value str Type of the S3 archive destination. defaults to \"s3\", must be one of [\"s3\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveIntegrationAzure/","text":"LogsArchiveIntegrationAzure The Azure archive's integration destination. Properties Name Type Description Notes client_id str A client ID. tenant_id str A tenant ID. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveIntegrationAzure"},{"location":"v2/LogsArchiveIntegrationAzure/#logsarchiveintegrationazure","text":"The Azure archive's integration destination.","title":"LogsArchiveIntegrationAzure"},{"location":"v2/LogsArchiveIntegrationAzure/#properties","text":"Name Type Description Notes client_id str A client ID. tenant_id str A tenant ID. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveIntegrationGCS/","text":"LogsArchiveIntegrationGCS The GCS archive's integration destination. Properties Name Type Description Notes client_email str A client email. project_id str A project ID. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveIntegrationGCS"},{"location":"v2/LogsArchiveIntegrationGCS/#logsarchiveintegrationgcs","text":"The GCS archive's integration destination.","title":"LogsArchiveIntegrationGCS"},{"location":"v2/LogsArchiveIntegrationGCS/#properties","text":"Name Type Description Notes client_email str A client email. project_id str A project ID. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveIntegrationS3/","text":"LogsArchiveIntegrationS3 The S3 Archive's integration destination. Properties Name Type Description Notes account_id str The account ID for the integration. role_name str The path of the integration. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveIntegrationS3"},{"location":"v2/LogsArchiveIntegrationS3/#logsarchiveintegrations3","text":"The S3 Archive's integration destination.","title":"LogsArchiveIntegrationS3"},{"location":"v2/LogsArchiveIntegrationS3/#properties","text":"Name Type Description Notes account_id str The account ID for the integration. role_name str The path of the integration. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrder/","text":"LogsArchiveOrder A ordered list of archive IDs. Properties Name Type Description Notes data LogsArchiveOrderDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrder"},{"location":"v2/LogsArchiveOrder/#logsarchiveorder","text":"A ordered list of archive IDs.","title":"LogsArchiveOrder"},{"location":"v2/LogsArchiveOrder/#properties","text":"Name Type Description Notes data LogsArchiveOrderDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrderAttributes/","text":"LogsArchiveOrderAttributes The attributes associated with the archive order. Properties Name Type Description Notes archive_ids [str] An ordered array of `` strings, the order of archive IDs in the array define the overall archives order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrderAttributes"},{"location":"v2/LogsArchiveOrderAttributes/#logsarchiveorderattributes","text":"The attributes associated with the archive order.","title":"LogsArchiveOrderAttributes"},{"location":"v2/LogsArchiveOrderAttributes/#properties","text":"Name Type Description Notes archive_ids [str] An ordered array of `` strings, the order of archive IDs in the array define the overall archives order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrderDefinition/","text":"LogsArchiveOrderDefinition The definition of an archive order. Properties Name Type Description Notes attributes LogsArchiveOrderAttributes type LogsArchiveOrderDefinitionType [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrderDefinition"},{"location":"v2/LogsArchiveOrderDefinition/#logsarchiveorderdefinition","text":"The definition of an archive order.","title":"LogsArchiveOrderDefinition"},{"location":"v2/LogsArchiveOrderDefinition/#properties","text":"Name Type Description Notes attributes LogsArchiveOrderAttributes type LogsArchiveOrderDefinitionType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrderDefinitionType/","text":"LogsArchiveOrderDefinitionType Type of the archive order definition. Properties Name Type Description Notes value str Type of the archive order definition. defaults to \"archive_order\", must be one of [\"archive_order\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrderDefinitionType"},{"location":"v2/LogsArchiveOrderDefinitionType/#logsarchiveorderdefinitiontype","text":"Type of the archive order definition.","title":"LogsArchiveOrderDefinitionType"},{"location":"v2/LogsArchiveOrderDefinitionType/#properties","text":"Name Type Description Notes value str Type of the archive order definition. defaults to \"archive_order\", must be one of [\"archive_order\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveState/","text":"LogsArchiveState The state of the archive. Properties Name Type Description Notes value str The state of the archive. must be one of [\"UNKNOWN\", \"WORKING\", \"FAILING\", \"WORKING_AUTH_LEGACY\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveState"},{"location":"v2/LogsArchiveState/#logsarchivestate","text":"The state of the archive.","title":"LogsArchiveState"},{"location":"v2/LogsArchiveState/#properties","text":"Name Type Description Notes value str The state of the archive. must be one of [\"UNKNOWN\", \"WORKING\", \"FAILING\", \"WORKING_AUTH_LEGACY\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchives/","text":"LogsArchives The available archives. Properties Name Type Description Notes data [LogsArchiveDefinition] A list of archives. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchives"},{"location":"v2/LogsArchives/#logsarchives","text":"The available archives.","title":"LogsArchives"},{"location":"v2/LogsArchives/#properties","text":"Name Type Description Notes data [LogsArchiveDefinition] A list of archives. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchivesApi/","text":"datadog_api_client.v2.LogsArchivesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive create_logs_archive POST /api/v2/logs/config/archives Create an archive delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive list_logs_archives GET /api/v2/logs/config/archives Get all archives remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order add_read_role_to_archive add_read_role_to_archive(archive_id, body) Grant role to an archive Adds a read role to an archive. ( Roles API ) Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Grant role to an archive api_instance.add_read_role_to_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->add_read_role_to_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_logs_archive LogsArchive create_logs_archive(body) Create an archive Create an archive in your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | The definition of the new archive. # example passing only required values which don't have defaults set try: # Create an archive api_response = api_instance.create_logs_archive(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->create_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes body LogsArchiveCreateRequest The definition of the new archive. Return type LogsArchive Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_logs_archive delete_logs_archive(archive_id) Delete an archive Delete a given archive from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Delete an archive api_instance.delete_logs_archive(archive_id) except ApiException as e: print(\"Exception when calling LogsArchivesApi->delete_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_archive LogsArchive get_logs_archive(archive_id) Get an archive Get a specific archive from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Get an archive api_response = api_instance.get_logs_archive(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. Return type LogsArchive Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_archive_order LogsArchiveOrder get_logs_archive_order() Get archive order Get the current order of your archives. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get archive order api_response = api_instance.get_logs_archive_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive_order: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsArchiveOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_archive_read_roles RolesResponse list_archive_read_roles(archive_id) List read roles for an archive Returns all read roles a given archive is restricted to. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # List read roles for an archive api_response = api_instance.list_archive_read_roles(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_archive_read_roles: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. Return type RolesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_archives LogsArchives list_logs_archives() Get all archives Get the list of configured logs archives with their definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all archives api_response = api_instance.list_logs_archives() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_logs_archives: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsArchives Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_role_from_archive remove_role_from_archive(archive_id, body) Revoke role from an archive Removes a role from an archive. ( Roles API ) Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Revoke role from an archive api_instance.remove_role_from_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->remove_role_from_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_archive LogsArchive update_logs_archive(archive_id, body) Update an archive Update a given archive configuration. Note : Using this method updates your archive configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | New definition of the archive. # example passing only required values which don't have defaults set try: # Update an archive api_response = api_instance.update_logs_archive(archive_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. body LogsArchiveCreateRequest New definition of the archive. Return type LogsArchive Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_archive_order LogsArchiveOrder update_logs_archive_order(body) Update archive order Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. Note : Using the PUT method updates your archive's order by replacing the current order with the new one. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveOrder( data=LogsArchiveOrderDefinition( attributes=LogsArchiveOrderAttributes( archive_ids=[\"a2zcMylnM4OCHpYusxIi1g\",\"a2zcMylnM4OCHpYusxIi2g\",\"a2zcMylnM4OCHpYusxIi3g\"], ), type=LogsArchiveOrderDefinitionType(\"archive_order\"), ), ) # LogsArchiveOrder | An object containing the new ordered list of archive IDs. # example passing only required values which don't have defaults set try: # Update archive order api_response = api_instance.update_logs_archive_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive_order: %s\\n\" % e) Parameters Name Type Description Notes body LogsArchiveOrder An object containing the new ordered list of archive IDs. Return type LogsArchiveOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.LogsArchivesApi"},{"location":"v2/LogsArchivesApi/#datadog_api_clientv2logsarchivesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive create_logs_archive POST /api/v2/logs/config/archives Create an archive delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive list_logs_archives GET /api/v2/logs/config/archives Get all archives remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order","title":"datadog_api_client.v2.LogsArchivesApi"},{"location":"v2/LogsArchivesApi/#add_read_role_to_archive","text":"add_read_role_to_archive(archive_id, body) Grant role to an archive Adds a read role to an archive. ( Roles API )","title":"add_read_role_to_archive"},{"location":"v2/LogsArchivesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Grant role to an archive api_instance.add_read_role_to_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->add_read_role_to_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters","text":"Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details","text":"Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#create_logs_archive","text":"LogsArchive create_logs_archive(body) Create an archive Create an archive in your organization.","title":"create_logs_archive"},{"location":"v2/LogsArchivesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | The definition of the new archive. # example passing only required values which don't have defaults set try: # Create an archive api_response = api_instance.create_logs_archive(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->create_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_1","text":"Name Type Description Notes body LogsArchiveCreateRequest The definition of the new archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_1","text":"LogsArchive","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#delete_logs_archive","text":"delete_logs_archive(archive_id) Delete an archive Delete a given archive from your organization.","title":"delete_logs_archive"},{"location":"v2/LogsArchivesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Delete an archive api_instance.delete_logs_archive(archive_id) except ApiException as e: print(\"Exception when calling LogsArchivesApi->delete_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_2","text":"Name Type Description Notes archive_id str The ID of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_2","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_2","text":"Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#get_logs_archive","text":"LogsArchive get_logs_archive(archive_id) Get an archive Get a specific archive from your organization.","title":"get_logs_archive"},{"location":"v2/LogsArchivesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Get an archive api_response = api_instance.get_logs_archive(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_3","text":"Name Type Description Notes archive_id str The ID of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_3","text":"LogsArchive","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#get_logs_archive_order","text":"LogsArchiveOrder get_logs_archive_order() Get archive order Get the current order of your archives. This endpoint takes no JSON arguments.","title":"get_logs_archive_order"},{"location":"v2/LogsArchivesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get archive order api_response = api_instance.get_logs_archive_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive_order: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_4","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_4","text":"LogsArchiveOrder","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#list_archive_read_roles","text":"RolesResponse list_archive_read_roles(archive_id) List read roles for an archive Returns all read roles a given archive is restricted to.","title":"list_archive_read_roles"},{"location":"v2/LogsArchivesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # List read roles for an archive api_response = api_instance.list_archive_read_roles(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_archive_read_roles: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_5","text":"Name Type Description Notes archive_id str The ID of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_5","text":"RolesResponse","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#list_logs_archives","text":"LogsArchives list_logs_archives() Get all archives Get the list of configured logs archives with their definitions.","title":"list_logs_archives"},{"location":"v2/LogsArchivesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all archives api_response = api_instance.list_logs_archives() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_logs_archives: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_6","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_6","text":"LogsArchives","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#remove_role_from_archive","text":"remove_role_from_archive(archive_id, body) Revoke role from an archive Removes a role from an archive. ( Roles API )","title":"remove_role_from_archive"},{"location":"v2/LogsArchivesApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Revoke role from an archive api_instance.remove_role_from_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->remove_role_from_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_7","text":"Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_7","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_7","text":"Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#update_logs_archive","text":"LogsArchive update_logs_archive(archive_id, body) Update an archive Update a given archive configuration. Note : Using this method updates your archive configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"update_logs_archive"},{"location":"v2/LogsArchivesApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | New definition of the archive. # example passing only required values which don't have defaults set try: # Update an archive api_response = api_instance.update_logs_archive(archive_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_8","text":"Name Type Description Notes archive_id str The ID of the archive. body LogsArchiveCreateRequest New definition of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_8","text":"LogsArchive","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#update_logs_archive_order","text":"LogsArchiveOrder update_logs_archive_order(body) Update archive order Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. Note : Using the PUT method updates your archive's order by replacing the current order with the new one.","title":"update_logs_archive_order"},{"location":"v2/LogsArchivesApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveOrder( data=LogsArchiveOrderDefinition( attributes=LogsArchiveOrderAttributes( archive_ids=[\"a2zcMylnM4OCHpYusxIi1g\",\"a2zcMylnM4OCHpYusxIi2g\",\"a2zcMylnM4OCHpYusxIi3g\"], ), type=LogsArchiveOrderDefinitionType(\"archive_order\"), ), ) # LogsArchiveOrder | An object containing the new ordered list of archive IDs. # example passing only required values which don't have defaults set try: # Update archive order api_response = api_instance.update_logs_archive_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive_order: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_9","text":"Name Type Description Notes body LogsArchiveOrder An object containing the new ordered list of archive IDs.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_9","text":"LogsArchiveOrder","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_9","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsCompute/","text":"LogsCompute A compute rule to compute metrics or timeseries Properties Name Type Description Notes aggregation LogsAggregationFunction interval str The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points [optional] metric str The metric to use [optional] type LogsComputeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCompute"},{"location":"v2/LogsCompute/#logscompute","text":"A compute rule to compute metrics or timeseries","title":"LogsCompute"},{"location":"v2/LogsCompute/#properties","text":"Name Type Description Notes aggregation LogsAggregationFunction interval str The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points [optional] metric str The metric to use [optional] type LogsComputeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsComputeType/","text":"LogsComputeType The type of compute Properties Name Type Description Notes value str The type of compute defaults to \"total\", must be one of [\"timeseries\", \"total\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsComputeType"},{"location":"v2/LogsComputeType/#logscomputetype","text":"The type of compute","title":"LogsComputeType"},{"location":"v2/LogsComputeType/#properties","text":"Name Type Description Notes value str The type of compute defaults to \"total\", must be one of [\"timeseries\", \"total\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupBy/","text":"LogsGroupBy A group by rule Properties Name Type Description Notes facet str The name of the facet to use (required) histogram LogsGroupByHistogram [optional] limit int The maximum buckets to return for this group by [optional] if omitted the server will use the default value of 10 missing LogsGroupByMissing [optional] sort LogsAggregateSort [optional] total LogsGroupByTotal [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupBy"},{"location":"v2/LogsGroupBy/#logsgroupby","text":"A group by rule","title":"LogsGroupBy"},{"location":"v2/LogsGroupBy/#properties","text":"Name Type Description Notes facet str The name of the facet to use (required) histogram LogsGroupByHistogram [optional] limit int The maximum buckets to return for this group by [optional] if omitted the server will use the default value of 10 missing LogsGroupByMissing [optional] sort LogsAggregateSort [optional] total LogsGroupByTotal [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupByHistogram/","text":"LogsGroupByHistogram Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval. 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) [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupByHistogram"},{"location":"v2/LogsGroupByHistogram/#logsgroupbyhistogram","text":"Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.","title":"LogsGroupByHistogram"},{"location":"v2/LogsGroupByHistogram/#properties","text":"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) [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupByMissing/","text":"LogsGroupByMissing The value to use for logs that don't have the facet used to group by Properties Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupByMissing"},{"location":"v2/LogsGroupByMissing/#logsgroupbymissing","text":"The value to use for logs that don't have the facet used to group by","title":"LogsGroupByMissing"},{"location":"v2/LogsGroupByMissing/#properties","text":"Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupByTotal/","text":"LogsGroupByTotal A resulting object to put the given computes in over all the matching records. Properties Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupByTotal"},{"location":"v2/LogsGroupByTotal/#logsgroupbytotal","text":"A resulting object to put the given computes in over all the matching records.","title":"LogsGroupByTotal"},{"location":"v2/LogsGroupByTotal/#properties","text":"Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListRequest/","text":"LogsListRequest The request for a logs list. Properties Name Type Description Notes filter LogsQueryFilter [optional] options LogsQueryOptions [optional] page LogsListRequestPage [optional] sort LogsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequest"},{"location":"v2/LogsListRequest/#logslistrequest","text":"The request for a logs list.","title":"LogsListRequest"},{"location":"v2/LogsListRequest/#properties","text":"Name Type Description Notes filter LogsQueryFilter [optional] options LogsQueryOptions [optional] page LogsListRequestPage [optional] sort LogsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListRequestPage/","text":"LogsListRequestPage Paging attributes for listing logs. Properties Name Type Description Notes cursor str List following results with a cursor provided in the previous query. [optional] limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequestPage"},{"location":"v2/LogsListRequestPage/#logslistrequestpage","text":"Paging attributes for listing logs.","title":"LogsListRequestPage"},{"location":"v2/LogsListRequestPage/#properties","text":"Name Type Description Notes cursor str List following results with a cursor provided in the previous query. [optional] limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListResponse/","text":"LogsListResponse Response object with all logs matching the request and pagination information. Properties Name Type Description Notes data [Log] Array of logs matching the request. [optional] links LogsListResponseLinks [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListResponse"},{"location":"v2/LogsListResponse/#logslistresponse","text":"Response object with all logs matching the request and pagination information.","title":"LogsListResponse"},{"location":"v2/LogsListResponse/#properties","text":"Name Type Description Notes data [Log] Array of logs matching the request. [optional] links LogsListResponseLinks [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListResponseLinks/","text":"LogsListResponseLinks Links attributes. Properties Name Type Description Notes next str Link for the next set of results. Note that the request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListResponseLinks"},{"location":"v2/LogsListResponseLinks/#logslistresponselinks","text":"Links attributes.","title":"LogsListResponseLinks"},{"location":"v2/LogsListResponseLinks/#properties","text":"Name Type Description Notes next str Link for the next set of results. Note that the request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCompute/","text":"LogsMetricCompute The compute rule to compute the log-based metric. Properties Name Type Description Notes aggregation_type LogsMetricComputeAggregationType path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCompute"},{"location":"v2/LogsMetricCompute/#logsmetriccompute","text":"The compute rule to compute the log-based metric.","title":"LogsMetricCompute"},{"location":"v2/LogsMetricCompute/#properties","text":"Name Type Description Notes aggregation_type LogsMetricComputeAggregationType path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricComputeAggregationType/","text":"LogsMetricComputeAggregationType The type of aggregation to use. Properties Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricComputeAggregationType"},{"location":"v2/LogsMetricComputeAggregationType/#logsmetriccomputeaggregationtype","text":"The type of aggregation to use.","title":"LogsMetricComputeAggregationType"},{"location":"v2/LogsMetricComputeAggregationType/#properties","text":"Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCreateAttributes/","text":"LogsMetricCreateAttributes The object describing the Datadog log-based metric to create. Properties Name Type Description Notes compute LogsMetricCompute filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCreateAttributes"},{"location":"v2/LogsMetricCreateAttributes/#logsmetriccreateattributes","text":"The object describing the Datadog log-based metric to create.","title":"LogsMetricCreateAttributes"},{"location":"v2/LogsMetricCreateAttributes/#properties","text":"Name Type Description Notes compute LogsMetricCompute filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCreateData/","text":"LogsMetricCreateData The new log-based metric properties. Properties Name Type Description Notes attributes LogsMetricCreateAttributes id str The name of the log-based metric. type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCreateData"},{"location":"v2/LogsMetricCreateData/#logsmetriccreatedata","text":"The new log-based metric properties.","title":"LogsMetricCreateData"},{"location":"v2/LogsMetricCreateData/#properties","text":"Name Type Description Notes attributes LogsMetricCreateAttributes id str The name of the log-based metric. type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCreateRequest/","text":"LogsMetricCreateRequest The new log-based metric body. Properties Name Type Description Notes data LogsMetricCreateData [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCreateRequest"},{"location":"v2/LogsMetricCreateRequest/#logsmetriccreaterequest","text":"The new log-based metric body.","title":"LogsMetricCreateRequest"},{"location":"v2/LogsMetricCreateRequest/#properties","text":"Name Type Description Notes data LogsMetricCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricFilter/","text":"LogsMetricFilter The log-based metric filter. Logs matching this filter will be aggregated in this metric. Properties Name Type Description Notes query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricFilter"},{"location":"v2/LogsMetricFilter/#logsmetricfilter","text":"The log-based metric filter. Logs matching this filter will be aggregated in this metric.","title":"LogsMetricFilter"},{"location":"v2/LogsMetricFilter/#properties","text":"Name Type Description Notes query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricGroupBy/","text":"LogsMetricGroupBy A group by rule. Properties Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricGroupBy"},{"location":"v2/LogsMetricGroupBy/#logsmetricgroupby","text":"A group by rule.","title":"LogsMetricGroupBy"},{"location":"v2/LogsMetricGroupBy/#properties","text":"Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponse/","text":"LogsMetricResponse The log-based metric object. Properties Name Type Description Notes data LogsMetricResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponse"},{"location":"v2/LogsMetricResponse/#logsmetricresponse","text":"The log-based metric object.","title":"LogsMetricResponse"},{"location":"v2/LogsMetricResponse/#properties","text":"Name Type Description Notes data LogsMetricResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseAttributes/","text":"LogsMetricResponseAttributes The object describing a Datadog log-based metric. Properties Name Type Description Notes compute LogsMetricResponseCompute [optional] filter LogsMetricResponseFilter [optional] group_by [LogsMetricResponseGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseAttributes"},{"location":"v2/LogsMetricResponseAttributes/#logsmetricresponseattributes","text":"The object describing a Datadog log-based metric.","title":"LogsMetricResponseAttributes"},{"location":"v2/LogsMetricResponseAttributes/#properties","text":"Name Type Description Notes compute LogsMetricResponseCompute [optional] filter LogsMetricResponseFilter [optional] group_by [LogsMetricResponseGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseCompute/","text":"LogsMetricResponseCompute The compute rule to compute the log-based metric. Properties Name Type Description Notes aggregation_type LogsMetricResponseComputeAggregationType [optional] path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseCompute"},{"location":"v2/LogsMetricResponseCompute/#logsmetricresponsecompute","text":"The compute rule to compute the log-based metric.","title":"LogsMetricResponseCompute"},{"location":"v2/LogsMetricResponseCompute/#properties","text":"Name Type Description Notes aggregation_type LogsMetricResponseComputeAggregationType [optional] path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseComputeAggregationType/","text":"LogsMetricResponseComputeAggregationType The type of aggregation to use. Properties Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseComputeAggregationType"},{"location":"v2/LogsMetricResponseComputeAggregationType/#logsmetricresponsecomputeaggregationtype","text":"The type of aggregation to use.","title":"LogsMetricResponseComputeAggregationType"},{"location":"v2/LogsMetricResponseComputeAggregationType/#properties","text":"Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseData/","text":"LogsMetricResponseData The log-based metric properties. Properties Name Type Description Notes attributes LogsMetricResponseAttributes [optional] id str The name of the log-based metric. [optional] type LogsMetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseData"},{"location":"v2/LogsMetricResponseData/#logsmetricresponsedata","text":"The log-based metric properties.","title":"LogsMetricResponseData"},{"location":"v2/LogsMetricResponseData/#properties","text":"Name Type Description Notes attributes LogsMetricResponseAttributes [optional] id str The name of the log-based metric. [optional] type LogsMetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseFilter/","text":"LogsMetricResponseFilter The log-based metric filter. Logs matching this filter will be aggregated in this metric. Properties Name Type Description Notes query str The search query - following the log search syntax. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseFilter"},{"location":"v2/LogsMetricResponseFilter/#logsmetricresponsefilter","text":"The log-based metric filter. Logs matching this filter will be aggregated in this metric.","title":"LogsMetricResponseFilter"},{"location":"v2/LogsMetricResponseFilter/#properties","text":"Name Type Description Notes query str The search query - following the log search syntax. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseGroupBy/","text":"LogsMetricResponseGroupBy A group by rule. Properties Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. [optional] tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseGroupBy"},{"location":"v2/LogsMetricResponseGroupBy/#logsmetricresponsegroupby","text":"A group by rule.","title":"LogsMetricResponseGroupBy"},{"location":"v2/LogsMetricResponseGroupBy/#properties","text":"Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. [optional] tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricType/","text":"LogsMetricType The type of the resource. The value should always be logs_metrics. Properties Name Type Description Notes value str The type of the resource. The value should always be logs_metrics. defaults to \"logs_metrics\", must be one of [\"logs_metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricType"},{"location":"v2/LogsMetricType/#logsmetrictype","text":"The type of the resource. The value should always be logs_metrics.","title":"LogsMetricType"},{"location":"v2/LogsMetricType/#properties","text":"Name Type Description Notes value str The type of the resource. The value should always be logs_metrics. defaults to \"logs_metrics\", must be one of [\"logs_metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricUpdateAttributes/","text":"LogsMetricUpdateAttributes The log-based metric properties that will be updated. Properties Name Type Description Notes filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricUpdateAttributes"},{"location":"v2/LogsMetricUpdateAttributes/#logsmetricupdateattributes","text":"The log-based metric properties that will be updated.","title":"LogsMetricUpdateAttributes"},{"location":"v2/LogsMetricUpdateAttributes/#properties","text":"Name Type Description Notes filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricUpdateData/","text":"LogsMetricUpdateData The new log-based metric properties. Properties Name Type Description Notes attributes LogsMetricUpdateAttributes type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricUpdateData"},{"location":"v2/LogsMetricUpdateData/#logsmetricupdatedata","text":"The new log-based metric properties.","title":"LogsMetricUpdateData"},{"location":"v2/LogsMetricUpdateData/#properties","text":"Name Type Description Notes attributes LogsMetricUpdateAttributes type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricUpdateRequest/","text":"LogsMetricUpdateRequest The new log-based metric body. Properties Name Type Description Notes data LogsMetricUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricUpdateRequest"},{"location":"v2/LogsMetricUpdateRequest/#logsmetricupdaterequest","text":"The new log-based metric body.","title":"LogsMetricUpdateRequest"},{"location":"v2/LogsMetricUpdateRequest/#properties","text":"Name Type Description Notes data LogsMetricUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricsApi/","text":"datadog_api_client.v2.LogsMetricsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric create_logs_metric LogsMetricResponse create_logs_metric(body) Create a log-based metric Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) body = LogsMetricCreateRequest( data=LogsMetricCreateData( attributes=LogsMetricCreateAttributes( compute=LogsMetricCompute( aggregation_type=LogsMetricComputeAggregationType(\"distribution\"), path=\"@duration\", ), filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), id=\"logs.page.load.count\", type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricCreateRequest | The definition of the new log-based metric. # example passing only required values which don't have defaults set try: # Create a log-based metric api_response = api_instance.create_logs_metric(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->create_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes body LogsMetricCreateRequest The definition of the new log-based metric. Return type LogsMetricResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 409 Conflict - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_logs_metric delete_logs_metric(metric_id) Delete a log-based metric Delete a specific log-based metric from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Delete a log-based metric api_instance.delete_logs_metric(metric_id) except ApiException as e: print(\"Exception when calling LogsMetricsApi->delete_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes metric_id str The name of the log-based metric. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_metric LogsMetricResponse get_logs_metric(metric_id) Get a log-based metric Get a specific log-based metric from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Get a log-based metric api_response = api_instance.get_logs_metric(metric_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->get_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes metric_id str The name of the log-based metric. Return type LogsMetricResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_metrics LogsMetricsResponse list_logs_metrics() Get all log-based metrics Get the list of configured log-based metrics with their definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all log-based metrics api_response = api_instance.list_logs_metrics() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->list_logs_metrics: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsMetricsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Not Authorized - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_metric LogsMetricResponse update_logs_metric(metric_id, body) Update a log-based metric Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. body = LogsMetricUpdateRequest( data=LogsMetricUpdateData( attributes=LogsMetricUpdateAttributes( filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricUpdateRequest | New definition of the log-based metric. # example passing only required values which don't have defaults set try: # Update a log-based metric api_response = api_instance.update_logs_metric(metric_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->update_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes metric_id str The name of the log-based metric. body LogsMetricUpdateRequest New definition of the log-based metric. Return type LogsMetricResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.LogsMetricsApi"},{"location":"v2/LogsMetricsApi/#datadog_api_clientv2logsmetricsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric","title":"datadog_api_client.v2.LogsMetricsApi"},{"location":"v2/LogsMetricsApi/#create_logs_metric","text":"LogsMetricResponse create_logs_metric(body) Create a log-based metric Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful.","title":"create_logs_metric"},{"location":"v2/LogsMetricsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) body = LogsMetricCreateRequest( data=LogsMetricCreateData( attributes=LogsMetricCreateAttributes( compute=LogsMetricCompute( aggregation_type=LogsMetricComputeAggregationType(\"distribution\"), path=\"@duration\", ), filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), id=\"logs.page.load.count\", type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricCreateRequest | The definition of the new log-based metric. # example passing only required values which don't have defaults set try: # Create a log-based metric api_response = api_instance.create_logs_metric(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->create_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters","text":"Name Type Description Notes body LogsMetricCreateRequest The definition of the new log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type","text":"LogsMetricResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 409 Conflict - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#delete_logs_metric","text":"delete_logs_metric(metric_id) Delete a log-based metric Delete a specific log-based metric from your organization.","title":"delete_logs_metric"},{"location":"v2/LogsMetricsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Delete a log-based metric api_instance.delete_logs_metric(metric_id) except ApiException as e: print(\"Exception when calling LogsMetricsApi->delete_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_1","text":"Name Type Description Notes metric_id str The name of the log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#get_logs_metric","text":"LogsMetricResponse get_logs_metric(metric_id) Get a log-based metric Get a specific log-based metric from your organization.","title":"get_logs_metric"},{"location":"v2/LogsMetricsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Get a log-based metric api_response = api_instance.get_logs_metric(metric_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->get_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_2","text":"Name Type Description Notes metric_id str The name of the log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_2","text":"LogsMetricResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#list_logs_metrics","text":"LogsMetricsResponse list_logs_metrics() Get all log-based metrics Get the list of configured log-based metrics with their definitions.","title":"list_logs_metrics"},{"location":"v2/LogsMetricsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all log-based metrics api_response = api_instance.list_logs_metrics() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->list_logs_metrics: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_3","text":"LogsMetricsResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Not Authorized - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#update_logs_metric","text":"LogsMetricResponse update_logs_metric(metric_id, body) Update a log-based metric Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful.","title":"update_logs_metric"},{"location":"v2/LogsMetricsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. body = LogsMetricUpdateRequest( data=LogsMetricUpdateData( attributes=LogsMetricUpdateAttributes( filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricUpdateRequest | New definition of the log-based metric. # example passing only required values which don't have defaults set try: # Update a log-based metric api_response = api_instance.update_logs_metric(metric_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->update_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_4","text":"Name Type Description Notes metric_id str The name of the log-based metric. body LogsMetricUpdateRequest New definition of the log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_4","text":"LogsMetricResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsResponse/","text":"LogsMetricsResponse All the available log-based metric objects. Properties Name Type Description Notes data [LogsMetricResponseData] A list of log-based metric objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricsResponse"},{"location":"v2/LogsMetricsResponse/#logsmetricsresponse","text":"All the available log-based metric objects.","title":"LogsMetricsResponse"},{"location":"v2/LogsMetricsResponse/#properties","text":"Name Type Description Notes data [LogsMetricResponseData] A list of log-based metric objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsQueryFilter/","text":"LogsQueryFilter The search and filter query settings Properties Name Type Description Notes _from str The minimum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now-15m\" indexes [str] For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. [optional] if omitted the server will use the default value of [\"*\"] query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" to str The maximum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsQueryFilter"},{"location":"v2/LogsQueryFilter/#logsqueryfilter","text":"The search and filter query settings","title":"LogsQueryFilter"},{"location":"v2/LogsQueryFilter/#properties","text":"Name Type Description Notes _from str The minimum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now-15m\" indexes [str] For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. [optional] if omitted the server will use the default value of [\"*\"] query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" to str The maximum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsQueryOptions/","text":"LogsQueryOptions Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail. Properties Name Type Description Notes time_offset int The time offset (in seconds) to apply to the query. [optional] timezone str The timezone can be specified both as an offset, for example: \\\"UTC+03:00\\\". [optional] if omitted the server will use the default value of \"UTC\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsQueryOptions"},{"location":"v2/LogsQueryOptions/#logsqueryoptions","text":"Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.","title":"LogsQueryOptions"},{"location":"v2/LogsQueryOptions/#properties","text":"Name Type Description Notes time_offset int The time offset (in seconds) to apply to the query. [optional] timezone str The timezone can be specified both as an offset, for example: \\\"UTC+03:00\\\". [optional] if omitted the server will use the default value of \"UTC\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsResponseMetadata/","text":"LogsResponseMetadata The metadata associated with a request Properties Name Type Description Notes elapsed int The time elapsed in milliseconds [optional] page LogsResponseMetadataPage [optional] request_id str The identifier of the request [optional] status LogsAggregateResponseStatus [optional] warnings [LogsWarning] A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsResponseMetadata"},{"location":"v2/LogsResponseMetadata/#logsresponsemetadata","text":"The metadata associated with a request","title":"LogsResponseMetadata"},{"location":"v2/LogsResponseMetadata/#properties","text":"Name Type Description Notes elapsed int The time elapsed in milliseconds [optional] page LogsResponseMetadataPage [optional] request_id str The identifier of the request [optional] status LogsAggregateResponseStatus [optional] warnings [LogsWarning] A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsResponseMetadataPage/","text":"LogsResponseMetadataPage Paging attributes. Properties Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsResponseMetadataPage"},{"location":"v2/LogsResponseMetadataPage/#logsresponsemetadatapage","text":"Paging attributes.","title":"LogsResponseMetadataPage"},{"location":"v2/LogsResponseMetadataPage/#properties","text":"Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsSort/","text":"LogsSort Sort parameters when querying logs. Properties Name Type Description Notes value str Sort parameters when querying logs. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsSort"},{"location":"v2/LogsSort/#logssort","text":"Sort parameters when querying logs.","title":"LogsSort"},{"location":"v2/LogsSort/#properties","text":"Name Type Description Notes value str Sort parameters when querying logs. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsSortOrder/","text":"LogsSortOrder The order to use, ascending or descending Properties Name Type Description Notes value str The order to use, ascending or descending must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsSortOrder"},{"location":"v2/LogsSortOrder/#logssortorder","text":"The order to use, ascending or descending","title":"LogsSortOrder"},{"location":"v2/LogsSortOrder/#properties","text":"Name Type Description Notes value str The order to use, ascending or descending must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsWarning/","text":"LogsWarning A warning message indicating something that went wrong with the query Properties Name Type Description Notes code str A unique code for this type of warning [optional] detail str A detailed explanation of this specific warning [optional] title str A short human-readable summary of the warning [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsWarning"},{"location":"v2/LogsWarning/#logswarning","text":"A warning message indicating something that went wrong with the query","title":"LogsWarning"},{"location":"v2/LogsWarning/#properties","text":"Name Type Description Notes code str A unique code for this type of warning [optional] detail str A detailed explanation of this specific warning [optional] title str A short human-readable summary of the warning [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Metric/","text":"Metric Object for a single metric tag configuration. Properties Name Type Description Notes id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Metric"},{"location":"v2/Metric/#metric","text":"Object for a single metric tag configuration.","title":"Metric"},{"location":"v2/Metric/#properties","text":"Name Type Description Notes id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricAllTags/","text":"MetricAllTags Object for a single metric's indexed tags. Properties Name Type Description Notes attributes MetricAllTagsAttributes [optional] id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricAllTags"},{"location":"v2/MetricAllTags/#metricalltags","text":"Object for a single metric's indexed tags.","title":"MetricAllTags"},{"location":"v2/MetricAllTags/#properties","text":"Name Type Description Notes attributes MetricAllTagsAttributes [optional] id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricAllTagsAttributes/","text":"MetricAllTagsAttributes Object containing the definition of a metric's tags. Properties Name Type Description Notes tags [str] List of indexed tag value pairs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricAllTagsAttributes"},{"location":"v2/MetricAllTagsAttributes/#metricalltagsattributes","text":"Object containing the definition of a metric's tags.","title":"MetricAllTagsAttributes"},{"location":"v2/MetricAllTagsAttributes/#properties","text":"Name Type Description Notes tags [str] List of indexed tag value pairs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricAllTagsResponse/","text":"MetricAllTagsResponse Response object that includes a single metric's indexed tags. Properties Name Type Description Notes data MetricAllTags [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricAllTagsResponse"},{"location":"v2/MetricAllTagsResponse/#metricalltagsresponse","text":"Response object that includes a single metric's indexed tags.","title":"MetricAllTagsResponse"},{"location":"v2/MetricAllTagsResponse/#properties","text":"Name Type Description Notes data MetricAllTags [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricDistinctVolume/","text":"MetricDistinctVolume Object for a single metric's distinct volume. Properties Name Type Description Notes attributes MetricDistinctVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricDistinctVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricDistinctVolume"},{"location":"v2/MetricDistinctVolume/#metricdistinctvolume","text":"Object for a single metric's distinct volume.","title":"MetricDistinctVolume"},{"location":"v2/MetricDistinctVolume/#properties","text":"Name Type Description Notes attributes MetricDistinctVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricDistinctVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricDistinctVolumeAttributes/","text":"MetricDistinctVolumeAttributes Object containing the definition of a metric's distinct volume. Properties Name Type Description Notes distinct_volume int Distinct volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricDistinctVolumeAttributes"},{"location":"v2/MetricDistinctVolumeAttributes/#metricdistinctvolumeattributes","text":"Object containing the definition of a metric's distinct volume.","title":"MetricDistinctVolumeAttributes"},{"location":"v2/MetricDistinctVolumeAttributes/#properties","text":"Name Type Description Notes distinct_volume int Distinct volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricDistinctVolumeType/","text":"MetricDistinctVolumeType The metric distinct volume type. Properties Name Type Description Notes value str The metric distinct volume type. defaults to \"distinct_metric_volumes\", must be one of [\"distinct_metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricDistinctVolumeType"},{"location":"v2/MetricDistinctVolumeType/#metricdistinctvolumetype","text":"The metric distinct volume type.","title":"MetricDistinctVolumeType"},{"location":"v2/MetricDistinctVolumeType/#properties","text":"Name Type Description Notes value str The metric distinct volume type. defaults to \"distinct_metric_volumes\", must be one of [\"distinct_metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricIngestedIndexedVolume/","text":"MetricIngestedIndexedVolume Object for a single metric's ingested and indexed volume. Properties Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricIngestedIndexedVolume"},{"location":"v2/MetricIngestedIndexedVolume/#metricingestedindexedvolume","text":"Object for a single metric's ingested and indexed volume.","title":"MetricIngestedIndexedVolume"},{"location":"v2/MetricIngestedIndexedVolume/#properties","text":"Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricIngestedIndexedVolumeAttributes/","text":"MetricIngestedIndexedVolumeAttributes Object containing the definition of a metric's ingested and indexed volume. Properties Name Type Description Notes indexed_volume int Indexed volume for the given metric. [optional] ingested_volume int Ingested volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricIngestedIndexedVolumeAttributes"},{"location":"v2/MetricIngestedIndexedVolumeAttributes/#metricingestedindexedvolumeattributes","text":"Object containing the definition of a metric's ingested and indexed volume.","title":"MetricIngestedIndexedVolumeAttributes"},{"location":"v2/MetricIngestedIndexedVolumeAttributes/#properties","text":"Name Type Description Notes indexed_volume int Indexed volume for the given metric. [optional] ingested_volume int Ingested volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricIngestedIndexedVolumeType/","text":"MetricIngestedIndexedVolumeType The metric ingested and indexed volume type. Properties Name Type Description Notes value str The metric ingested and indexed volume type. defaults to \"metric_volumes\", must be one of [\"metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricIngestedIndexedVolumeType"},{"location":"v2/MetricIngestedIndexedVolumeType/#metricingestedindexedvolumetype","text":"The metric ingested and indexed volume type.","title":"MetricIngestedIndexedVolumeType"},{"location":"v2/MetricIngestedIndexedVolumeType/#properties","text":"Name Type Description Notes value str The metric ingested and indexed volume type. defaults to \"metric_volumes\", must be one of [\"metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfiguration/","text":"MetricTagConfiguration Object for a single metric tag configuration. Properties Name Type Description Notes attributes MetricTagConfigurationAttributes [optional] id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfiguration"},{"location":"v2/MetricTagConfiguration/#metrictagconfiguration","text":"Object for a single metric tag configuration.","title":"MetricTagConfiguration"},{"location":"v2/MetricTagConfiguration/#properties","text":"Name Type Description Notes attributes MetricTagConfigurationAttributes [optional] id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationAttributes/","text":"MetricTagConfigurationAttributes Object containing the definition of a metric tag configuration attributes. Properties Name Type Description Notes created_at datetime Timestamp when the tag configuration was created. [optional] include_percentiles bool Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. [optional] metric_type MetricTagConfigurationMetricTypes [optional] modified_at datetime Timestamp when the tag configuration was last modified. [optional] tags [str] List of tag keys on which to group. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationAttributes"},{"location":"v2/MetricTagConfigurationAttributes/#metrictagconfigurationattributes","text":"Object containing the definition of a metric tag configuration attributes.","title":"MetricTagConfigurationAttributes"},{"location":"v2/MetricTagConfigurationAttributes/#properties","text":"Name Type Description Notes created_at datetime Timestamp when the tag configuration was created. [optional] include_percentiles bool Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. [optional] metric_type MetricTagConfigurationMetricTypes [optional] modified_at datetime Timestamp when the tag configuration was last modified. [optional] tags [str] List of tag keys on which to group. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationCreateAttributes/","text":"MetricTagConfigurationCreateAttributes Object containing the definition of a metric tag configuration to be created. Properties Name Type Description Notes metric_type MetricTagConfigurationMetricTypes tags [str] A list of tag keys that will be queryable for your metric. defaults to [] include_percentiles bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationCreateAttributes"},{"location":"v2/MetricTagConfigurationCreateAttributes/#metrictagconfigurationcreateattributes","text":"Object containing the definition of a metric tag configuration to be created.","title":"MetricTagConfigurationCreateAttributes"},{"location":"v2/MetricTagConfigurationCreateAttributes/#properties","text":"Name Type Description Notes metric_type MetricTagConfigurationMetricTypes tags [str] A list of tag keys that will be queryable for your metric. defaults to [] include_percentiles bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationCreateData/","text":"MetricTagConfigurationCreateData Object for a single metric to be configure tags on. Properties Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationCreateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationCreateData"},{"location":"v2/MetricTagConfigurationCreateData/#metrictagconfigurationcreatedata","text":"Object for a single metric to be configure tags on.","title":"MetricTagConfigurationCreateData"},{"location":"v2/MetricTagConfigurationCreateData/#properties","text":"Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationCreateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationCreateRequest/","text":"MetricTagConfigurationCreateRequest Request object that includes the metric that you would like to configure tags for. Properties Name Type Description Notes data MetricTagConfigurationCreateData [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationCreateRequest"},{"location":"v2/MetricTagConfigurationCreateRequest/#metrictagconfigurationcreaterequest","text":"Request object that includes the metric that you would like to configure tags for.","title":"MetricTagConfigurationCreateRequest"},{"location":"v2/MetricTagConfigurationCreateRequest/#properties","text":"Name Type Description Notes data MetricTagConfigurationCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationMetricTypes/","text":"MetricTagConfigurationMetricTypes The metric's type. Properties Name Type Description Notes value str The metric's type. defaults to \"gauge\", must be one of [\"gauge\", \"count\", \"rate\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationMetricTypes"},{"location":"v2/MetricTagConfigurationMetricTypes/#metrictagconfigurationmetrictypes","text":"The metric's type.","title":"MetricTagConfigurationMetricTypes"},{"location":"v2/MetricTagConfigurationMetricTypes/#properties","text":"Name Type Description Notes value str The metric's type. defaults to \"gauge\", must be one of [\"gauge\", \"count\", \"rate\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationResponse/","text":"MetricTagConfigurationResponse Response object which includes a single metric's tag configuration. Properties Name Type Description Notes data MetricTagConfiguration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationResponse"},{"location":"v2/MetricTagConfigurationResponse/#metrictagconfigurationresponse","text":"Response object which includes a single metric's tag configuration.","title":"MetricTagConfigurationResponse"},{"location":"v2/MetricTagConfigurationResponse/#properties","text":"Name Type Description Notes data MetricTagConfiguration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationType/","text":"MetricTagConfigurationType The metric tag configuration resource type. Properties Name Type Description Notes value str The metric tag configuration resource type. defaults to \"manage_tags\", must be one of [\"manage_tags\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationType"},{"location":"v2/MetricTagConfigurationType/#metrictagconfigurationtype","text":"The metric tag configuration resource type.","title":"MetricTagConfigurationType"},{"location":"v2/MetricTagConfigurationType/#properties","text":"Name Type Description Notes value str The metric tag configuration resource type. defaults to \"manage_tags\", must be one of [\"manage_tags\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationUpdateAttributes/","text":"MetricTagConfigurationUpdateAttributes Object containing the definition of a metric tag configuration to be updated. Properties Name Type Description Notes include_percentiles bool 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] if omitted the server will use the default value of False tags [str] A list of tag keys that will be queryable for your metric. [optional] if omitted the server will use the default value of [] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationUpdateAttributes"},{"location":"v2/MetricTagConfigurationUpdateAttributes/#metrictagconfigurationupdateattributes","text":"Object containing the definition of a metric tag configuration to be updated.","title":"MetricTagConfigurationUpdateAttributes"},{"location":"v2/MetricTagConfigurationUpdateAttributes/#properties","text":"Name Type Description Notes include_percentiles bool 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] if omitted the server will use the default value of False tags [str] A list of tag keys that will be queryable for your metric. [optional] if omitted the server will use the default value of [] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationUpdateData/","text":"MetricTagConfigurationUpdateData Object for a single tag configuration to be edited. Properties Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationUpdateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationUpdateData"},{"location":"v2/MetricTagConfigurationUpdateData/#metrictagconfigurationupdatedata","text":"Object for a single tag configuration to be edited.","title":"MetricTagConfigurationUpdateData"},{"location":"v2/MetricTagConfigurationUpdateData/#properties","text":"Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationUpdateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationUpdateRequest/","text":"MetricTagConfigurationUpdateRequest Request object that includes the metric that you would like to edit the tag configuration on. Properties Name Type Description Notes data MetricTagConfigurationUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationUpdateRequest"},{"location":"v2/MetricTagConfigurationUpdateRequest/#metrictagconfigurationupdaterequest","text":"Request object that includes the metric that you would like to edit the tag configuration on.","title":"MetricTagConfigurationUpdateRequest"},{"location":"v2/MetricTagConfigurationUpdateRequest/#properties","text":"Name Type Description Notes data MetricTagConfigurationUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricType/","text":"MetricType The metric resource type. Properties Name Type Description Notes value str The metric resource type. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricType"},{"location":"v2/MetricType/#metrictype","text":"The metric resource type.","title":"MetricType"},{"location":"v2/MetricType/#properties","text":"Name Type Description Notes value str The metric resource type. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricVolumes/","text":"MetricVolumes Possible response objects for a metric's volume. Properties Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricVolumes"},{"location":"v2/MetricVolumes/#metricvolumes","text":"Possible response objects for a metric's volume.","title":"MetricVolumes"},{"location":"v2/MetricVolumes/#properties","text":"Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricVolumesResponse/","text":"MetricVolumesResponse Response object which includes a single metric's volume. Properties Name Type Description Notes data MetricVolumes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricVolumesResponse"},{"location":"v2/MetricVolumesResponse/#metricvolumesresponse","text":"Response object which includes a single metric's volume.","title":"MetricVolumesResponse"},{"location":"v2/MetricVolumesResponse/#properties","text":"Name Type Description Notes data MetricVolumes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricsAndMetricTagConfigurations/","text":"MetricsAndMetricTagConfigurations Object for a metrics and metric tag configurations. Properties Name Type Description Notes id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] attributes MetricTagConfigurationAttributes [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricsAndMetricTagConfigurations"},{"location":"v2/MetricsAndMetricTagConfigurations/#metricsandmetrictagconfigurations","text":"Object for a metrics and metric tag configurations.","title":"MetricsAndMetricTagConfigurations"},{"location":"v2/MetricsAndMetricTagConfigurations/#properties","text":"Name Type Description Notes id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] attributes MetricTagConfigurationAttributes [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricsAndMetricTagConfigurationsResponse/","text":"MetricsAndMetricTagConfigurationsResponse Response object that includes metrics and metric tag configurations. Properties Name Type Description Notes data [MetricsAndMetricTagConfigurations] Array of metrics and metric tag configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricsAndMetricTagConfigurationsResponse"},{"location":"v2/MetricsAndMetricTagConfigurationsResponse/#metricsandmetrictagconfigurationsresponse","text":"Response object that includes metrics and metric tag configurations.","title":"MetricsAndMetricTagConfigurationsResponse"},{"location":"v2/MetricsAndMetricTagConfigurationsResponse/#properties","text":"Name Type Description Notes data [MetricsAndMetricTagConfigurations] Array of metrics and metric tag configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricsApi/","text":"datadog_api_client.v2.MetricsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name list_tag_configurations GET /api/v2/metrics List tag configurations list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration create_tag_configuration MetricTagConfigurationResponse create_tag_configuration(metric_name, body) Create a tag configuration Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric. Can only be used with application keys of users with the Manage Tags for Metrics permission. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationCreateRequest( data=MetricTagConfigurationCreateData( attributes=MetricTagConfigurationCreateAttributes( include_percentiles=True, metric_type=MetricTagConfigurationMetricTypes(\"count\"), tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationCreateRequest | # example passing only required values which don't have defaults set try: # Create a tag configuration api_response = api_instance.create_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->create_tag_configuration: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationCreateRequest Return type MetricTagConfigurationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - 409 Conflict - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_tag_configuration delete_tag_configuration(metric_name) Delete a tag configuration Deletes a metric's tag configuration. Can only be used with application keys from users with the Manage Tags for Metrics permission. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # Delete a tag configuration api_instance.delete_tag_configuration(metric_name) except ApiException as e: print(\"Exception when calling MetricsApi->delete_tag_configuration: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tag_configuration_by_name MetricTagConfigurationResponse list_tag_configuration_by_name(metric_name) List tag configuration by name Returns the tag configuration for the given metric name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configuration_by_name\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tag configuration by name api_response = api_instance.list_tag_configuration_by_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configuration_by_name: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type MetricTagConfigurationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tag_configurations MetricsAndMetricTagConfigurationsResponse list_tag_configurations() List tag configurations Returns all configured count/gauge/rate/distribution metric names (with additional filters if specified). Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configurations\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) filter_configured = True # bool | Filter metrics that have configured tags. (optional) filter_tags_configured = \"app\" # str | Filter tag configurations by configured tags. (optional) filter_metric_type = MetricTagConfigurationMetricTypes(\"count\") # MetricTagConfigurationMetricTypes | Filter tag configurations by metric type. (optional) filter_include_percentiles = True # bool | Filter distributions with additional percentile aggregations enabled or disabled. (optional) filter_tags = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) window_seconds = 3600 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # List tag configurations api_response = api_instance.list_tag_configurations(filter_configured=filter_configured, filter_tags_configured=filter_tags_configured, filter_metric_type=filter_metric_type, filter_include_percentiles=filter_include_percentiles, filter_tags=filter_tags, window_seconds=window_seconds) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configurations: %s\\n\" % e) Parameters Name Type Description Notes filter_configured bool Filter metrics that have configured tags. [optional] filter_tags_configured str Filter tag configurations by configured tags. [optional] filter_metric_type MetricTagConfigurationMetricTypes Filter tag configurations by metric type. [optional] filter_include_percentiles bool Filter distributions with additional percentile aggregations enabled or disabled. [optional] filter_tags str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional] window_seconds int 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 MetricsAndMetricTagConfigurationsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tags_by_metric_name MetricAllTagsResponse list_tags_by_metric_name(metric_name) List tags by metric name View indexed tag key-value pairs for a given metric name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tags by metric name api_response = api_instance.list_tags_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tags_by_metric_name: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type MetricAllTagsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_volumes_by_metric_name MetricVolumesResponse list_volumes_by_metric_name(metric_name) List distinct metric volumes by metric name View distinct metrics volumes for the given metric name. Custom distribution metrics will return both ingested and indexed custom metric volumes. For Metrics without Limits\u2122 beta customers, all metrics will return both ingested/indexed volumes. Custom metrics generated in-app from other products will return null for ingested volumes. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List distinct metric volumes by metric name api_response = api_instance.list_volumes_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_volumes_by_metric_name: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type MetricVolumesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_tag_configuration MetricTagConfigurationResponse update_tag_configuration(metric_name, body) Update a tag configuration Update the tag configuration of a metric or percentile aggregations of a distribution metric. Can only be used with application keys from users with the Manage Tags for Metrics permission. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationUpdateRequest( data=MetricTagConfigurationUpdateData( attributes=MetricTagConfigurationUpdateAttributes( include_percentiles=True, tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationUpdateRequest | # example passing only required values which don't have defaults set try: # Update a tag configuration api_response = api_instance.update_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_tag_configuration: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationUpdateRequest Return type MetricTagConfigurationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.MetricsApi"},{"location":"v2/MetricsApi/#datadog_api_clientv2metricsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name list_tag_configurations GET /api/v2/metrics List tag configurations list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration","title":"datadog_api_client.v2.MetricsApi"},{"location":"v2/MetricsApi/#create_tag_configuration","text":"MetricTagConfigurationResponse create_tag_configuration(metric_name, body) Create a tag configuration Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric. Can only be used with application keys of users with the Manage Tags for Metrics permission.","title":"create_tag_configuration"},{"location":"v2/MetricsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationCreateRequest( data=MetricTagConfigurationCreateData( attributes=MetricTagConfigurationCreateAttributes( include_percentiles=True, metric_type=MetricTagConfigurationMetricTypes(\"count\"), tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationCreateRequest | # example passing only required values which don't have defaults set try: # Create a tag configuration api_response = api_instance.create_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->create_tag_configuration: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters","text":"Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationCreateRequest","title":"Parameters"},{"location":"v2/MetricsApi/#return-type","text":"MetricTagConfigurationResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details","text":"Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - 409 Conflict - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#delete_tag_configuration","text":"delete_tag_configuration(metric_name) Delete a tag configuration Deletes a metric's tag configuration. Can only be used with application keys from users with the Manage Tags for Metrics permission.","title":"delete_tag_configuration"},{"location":"v2/MetricsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # Delete a tag configuration api_instance.delete_tag_configuration(metric_name) except ApiException as e: print(\"Exception when calling MetricsApi->delete_tag_configuration: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_1","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/MetricsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_1","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_tag_configuration_by_name","text":"MetricTagConfigurationResponse list_tag_configuration_by_name(metric_name) List tag configuration by name Returns the tag configuration for the given metric name.","title":"list_tag_configuration_by_name"},{"location":"v2/MetricsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configuration_by_name\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tag configuration by name api_response = api_instance.list_tag_configuration_by_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configuration_by_name: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_2","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_2","text":"MetricTagConfigurationResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_2","text":"Status code Description Response headers 200 Success - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_tag_configurations","text":"MetricsAndMetricTagConfigurationsResponse list_tag_configurations() List tag configurations Returns all configured count/gauge/rate/distribution metric names (with additional filters if specified).","title":"list_tag_configurations"},{"location":"v2/MetricsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configurations\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) filter_configured = True # bool | Filter metrics that have configured tags. (optional) filter_tags_configured = \"app\" # str | Filter tag configurations by configured tags. (optional) filter_metric_type = MetricTagConfigurationMetricTypes(\"count\") # MetricTagConfigurationMetricTypes | Filter tag configurations by metric type. (optional) filter_include_percentiles = True # bool | Filter distributions with additional percentile aggregations enabled or disabled. (optional) filter_tags = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) window_seconds = 3600 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # List tag configurations api_response = api_instance.list_tag_configurations(filter_configured=filter_configured, filter_tags_configured=filter_tags_configured, filter_metric_type=filter_metric_type, filter_include_percentiles=filter_include_percentiles, filter_tags=filter_tags, window_seconds=window_seconds) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configurations: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_3","text":"Name Type Description Notes filter_configured bool Filter metrics that have configured tags. [optional] filter_tags_configured str Filter tag configurations by configured tags. [optional] filter_metric_type MetricTagConfigurationMetricTypes Filter tag configurations by metric type. [optional] filter_include_percentiles bool Filter distributions with additional percentile aggregations enabled or disabled. [optional] filter_tags str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional] window_seconds int 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]","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_3","text":"MetricsAndMetricTagConfigurationsResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_3","text":"Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_tags_by_metric_name","text":"MetricAllTagsResponse list_tags_by_metric_name(metric_name) List tags by metric name View indexed tag key-value pairs for a given metric name.","title":"list_tags_by_metric_name"},{"location":"v2/MetricsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tags by metric name api_response = api_instance.list_tags_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tags_by_metric_name: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_4","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_4","text":"MetricAllTagsResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_4","text":"Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_volumes_by_metric_name","text":"MetricVolumesResponse list_volumes_by_metric_name(metric_name) List distinct metric volumes by metric name View distinct metrics volumes for the given metric name. Custom distribution metrics will return both ingested and indexed custom metric volumes. For Metrics without Limits\u2122 beta customers, all metrics will return both ingested/indexed volumes. Custom metrics generated in-app from other products will return null for ingested volumes.","title":"list_volumes_by_metric_name"},{"location":"v2/MetricsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List distinct metric volumes by metric name api_response = api_instance.list_volumes_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_volumes_by_metric_name: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_5","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_5","text":"MetricVolumesResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_5","text":"Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#update_tag_configuration","text":"MetricTagConfigurationResponse update_tag_configuration(metric_name, body) Update a tag configuration Update the tag configuration of a metric or percentile aggregations of a distribution metric. Can only be used with application keys from users with the Manage Tags for Metrics permission.","title":"update_tag_configuration"},{"location":"v2/MetricsApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationUpdateRequest( data=MetricTagConfigurationUpdateData( attributes=MetricTagConfigurationUpdateAttributes( include_percentiles=True, tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationUpdateRequest | # example passing only required values which don't have defaults set try: # Update a tag configuration api_response = api_instance.update_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_tag_configuration: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_6","text":"Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationUpdateRequest","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_6","text":"MetricTagConfigurationResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/Organization/","text":"Organization Organization object. Properties Name Type Description Notes type OrganizationsType attributes OrganizationAttributes [optional] id str ID of the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Organization"},{"location":"v2/Organization/#organization","text":"Organization object.","title":"Organization"},{"location":"v2/Organization/#properties","text":"Name Type Description Notes type OrganizationsType attributes OrganizationAttributes [optional] id str ID of the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/OrganizationAttributes/","text":"OrganizationAttributes Attributes of the organization. Properties Name Type Description Notes created_at datetime Creation time of the organization. [optional] description str Description of the organization. [optional] disabled bool Whether or not the organization is disabled. [optional] modified_at datetime Time of last organization modification. [optional] name str Name of the organization. [optional] public_id str Public ID of the organization. [optional] sharing str Sharing type of the organization. [optional] url str URL of the site that this organization exists at. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationAttributes"},{"location":"v2/OrganizationAttributes/#organizationattributes","text":"Attributes of the organization.","title":"OrganizationAttributes"},{"location":"v2/OrganizationAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the organization. [optional] description str Description of the organization. [optional] disabled bool Whether or not the organization is disabled. [optional] modified_at datetime Time of last organization modification. [optional] name str Name of the organization. [optional] public_id str Public ID of the organization. [optional] sharing str Sharing type of the organization. [optional] url str URL of the site that this organization exists at. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/OrganizationsType/","text":"OrganizationsType Organizations resource type. Properties Name Type Description Notes value str Organizations resource type. defaults to \"orgs\", must be one of [\"orgs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationsType"},{"location":"v2/OrganizationsType/#organizationstype","text":"Organizations resource type.","title":"OrganizationsType"},{"location":"v2/OrganizationsType/#properties","text":"Name Type Description Notes value str Organizations resource type. defaults to \"orgs\", must be one of [\"orgs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Pagination/","text":"Pagination Pagination object. Properties Name Type Description Notes total_count int Total count. [optional] total_filtered_count int Total count of elements matched by the filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Pagination"},{"location":"v2/Pagination/#pagination","text":"Pagination object.","title":"Pagination"},{"location":"v2/Pagination/#properties","text":"Name Type Description Notes total_count int Total count. [optional] total_filtered_count int Total count of elements matched by the filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialAPIKey/","text":"PartialAPIKey Partial Datadog API key. Properties Name Type Description Notes attributes PartialAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialAPIKey"},{"location":"v2/PartialAPIKey/#partialapikey","text":"Partial Datadog API key.","title":"PartialAPIKey"},{"location":"v2/PartialAPIKey/#properties","text":"Name Type Description Notes attributes PartialAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialAPIKeyAttributes/","text":"PartialAPIKeyAttributes Attributes of a partial API key. Properties Name Type Description Notes created_at str Creation date of the API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialAPIKeyAttributes"},{"location":"v2/PartialAPIKeyAttributes/#partialapikeyattributes","text":"Attributes of a partial API key.","title":"PartialAPIKeyAttributes"},{"location":"v2/PartialAPIKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialApplicationKey/","text":"PartialApplicationKey Partial Datadog application key. Properties Name Type Description Notes attributes PartialApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialApplicationKey"},{"location":"v2/PartialApplicationKey/#partialapplicationkey","text":"Partial Datadog application key.","title":"PartialApplicationKey"},{"location":"v2/PartialApplicationKey/#properties","text":"Name Type Description Notes attributes PartialApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialApplicationKeyAttributes/","text":"PartialApplicationKeyAttributes Attributes of a partial application key. Properties Name Type Description Notes created_at str Creation date of the application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialApplicationKeyAttributes"},{"location":"v2/PartialApplicationKeyAttributes/#partialapplicationkeyattributes","text":"Attributes of a partial application key.","title":"PartialApplicationKeyAttributes"},{"location":"v2/PartialApplicationKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Permission/","text":"Permission Permission object. Properties Name Type Description Notes type PermissionsType attributes PermissionAttributes [optional] id str ID of the permission. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Permission"},{"location":"v2/Permission/#permission","text":"Permission object.","title":"Permission"},{"location":"v2/Permission/#properties","text":"Name Type Description Notes type PermissionsType attributes PermissionAttributes [optional] id str ID of the permission. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PermissionAttributes/","text":"PermissionAttributes Attributes of a permission. Properties Name Type Description Notes created datetime Creation time of the permission. [optional] description str Description of the permission. [optional] display_name str Displayed name for the permission. [optional] display_type str Display type. [optional] group_name str Name of the permission group. [optional] name str Name of the permission. [optional] restricted bool Whether or not the permission is restricted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PermissionAttributes"},{"location":"v2/PermissionAttributes/#permissionattributes","text":"Attributes of a permission.","title":"PermissionAttributes"},{"location":"v2/PermissionAttributes/#properties","text":"Name Type Description Notes created datetime Creation time of the permission. [optional] description str Description of the permission. [optional] display_name str Displayed name for the permission. [optional] display_type str Display type. [optional] group_name str Name of the permission group. [optional] name str Name of the permission. [optional] restricted bool Whether or not the permission is restricted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PermissionsResponse/","text":"PermissionsResponse Payload with API-returned permissions. Properties Name Type Description Notes data [Permission] Array of permissions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PermissionsResponse"},{"location":"v2/PermissionsResponse/#permissionsresponse","text":"Payload with API-returned permissions.","title":"PermissionsResponse"},{"location":"v2/PermissionsResponse/#properties","text":"Name Type Description Notes data [Permission] Array of permissions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PermissionsType/","text":"PermissionsType Permissions resource type. Properties Name Type Description Notes value str Permissions resource type. defaults to \"permissions\", must be one of [\"permissions\", ] [Back to Model list] [Back to API list] [Back to README]","title":"PermissionsType"},{"location":"v2/PermissionsType/#permissionstype","text":"Permissions resource type.","title":"PermissionsType"},{"location":"v2/PermissionsType/#properties","text":"Name Type Description Notes value str Permissions resource type. defaults to \"permissions\", must be one of [\"permissions\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummariesMeta/","text":"ProcessSummariesMeta Response metadata object. Properties Name Type Description Notes page ProcessSummariesMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummariesMeta"},{"location":"v2/ProcessSummariesMeta/#processsummariesmeta","text":"Response metadata object.","title":"ProcessSummariesMeta"},{"location":"v2/ProcessSummariesMeta/#properties","text":"Name Type Description Notes page ProcessSummariesMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummariesMetaPage/","text":"ProcessSummariesMetaPage Paging attributes. Properties Name Type Description Notes after str 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 int Number of results returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummariesMetaPage"},{"location":"v2/ProcessSummariesMetaPage/#processsummariesmetapage","text":"Paging attributes.","title":"ProcessSummariesMetaPage"},{"location":"v2/ProcessSummariesMetaPage/#properties","text":"Name Type Description Notes after str 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 int Number of results returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummariesResponse/","text":"ProcessSummariesResponse List of process summaries. Properties Name Type Description Notes data [ProcessSummary] Array of process summary objects. [optional] meta ProcessSummariesMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummariesResponse"},{"location":"v2/ProcessSummariesResponse/#processsummariesresponse","text":"List of process summaries.","title":"ProcessSummariesResponse"},{"location":"v2/ProcessSummariesResponse/#properties","text":"Name Type Description Notes data [ProcessSummary] Array of process summary objects. [optional] meta ProcessSummariesMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummary/","text":"ProcessSummary Process summary object. Properties Name Type Description Notes attributes ProcessSummaryAttributes [optional] id str Process ID. [optional] type ProcessSummaryType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummary"},{"location":"v2/ProcessSummary/#processsummary","text":"Process summary object.","title":"ProcessSummary"},{"location":"v2/ProcessSummary/#properties","text":"Name Type Description Notes attributes ProcessSummaryAttributes [optional] id str Process ID. [optional] type ProcessSummaryType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummaryAttributes/","text":"ProcessSummaryAttributes Attributes for a process summary. Properties Name Type Description Notes cmdline str Process command line. [optional] host str Host running the process. [optional] pid int Process ID. [optional] ppid int Parent process ID. [optional] start str Time the process was started. [optional] tags [str] List of tags associated with the process. [optional] timestamp str Time the process was seen. [optional] user str Process owner. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummaryAttributes"},{"location":"v2/ProcessSummaryAttributes/#processsummaryattributes","text":"Attributes for a process summary.","title":"ProcessSummaryAttributes"},{"location":"v2/ProcessSummaryAttributes/#properties","text":"Name Type Description Notes cmdline str Process command line. [optional] host str Host running the process. [optional] pid int Process ID. [optional] ppid int Parent process ID. [optional] start str Time the process was started. [optional] tags [str] List of tags associated with the process. [optional] timestamp str Time the process was seen. [optional] user str Process owner. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummaryType/","text":"ProcessSummaryType Type of process summary. Properties Name Type Description Notes value str Type of process summary. defaults to \"process\", must be one of [\"process\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummaryType"},{"location":"v2/ProcessSummaryType/#processsummarytype","text":"Type of process summary.","title":"ProcessSummaryType"},{"location":"v2/ProcessSummaryType/#properties","text":"Name Type Description Notes value str Type of process summary. defaults to \"process\", must be one of [\"process\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessesApi/","text":"datadog_api_client.v2.ProcessesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_processes GET /api/v2/processes Get all processes list_processes ProcessSummariesResponse list_processes() Get all processes Get all processes for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import processes_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = processes_api.ProcessesApi(api_client) search = \"search_example\" # str | String to search processes by. (optional) tags = \"account:prod,user:admin\" # str | Comma-separated list of tags to filter processes by. (optional) _from = 1 # int | 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 = 1 # int | 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 = 1000 # int | Maximum number of results returned. (optional) if omitted the server will use the default value of 1000 page_cursor = \"page[cursor]_example\" # str | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all processes api_response = api_instance.list_processes(search=search, tags=tags, _from=_from, to=to, page_limit=page_limit, page_cursor=page_cursor) pprint(api_response) except ApiException as e: print(\"Exception when calling ProcessesApi->list_processes: %s\\n\" % e) Parameters Name Type Description Notes search str String to search processes by. [optional] tags str Comma-separated list of tags to filter processes by. [optional] _from int 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 int 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 int Maximum number of results returned. [optional] if omitted the server will use the default value of 1000 page_cursor str 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 ProcessSummariesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.ProcessesApi"},{"location":"v2/ProcessesApi/#datadog_api_clientv2processesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_processes GET /api/v2/processes Get all processes","title":"datadog_api_client.v2.ProcessesApi"},{"location":"v2/ProcessesApi/#list_processes","text":"ProcessSummariesResponse list_processes() Get all processes Get all processes for your organization.","title":"list_processes"},{"location":"v2/ProcessesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import processes_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = processes_api.ProcessesApi(api_client) search = \"search_example\" # str | String to search processes by. (optional) tags = \"account:prod,user:admin\" # str | Comma-separated list of tags to filter processes by. (optional) _from = 1 # int | 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 = 1 # int | 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 = 1000 # int | Maximum number of results returned. (optional) if omitted the server will use the default value of 1000 page_cursor = \"page[cursor]_example\" # str | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all processes api_response = api_instance.list_processes(search=search, tags=tags, _from=_from, to=to, page_limit=page_limit, page_cursor=page_cursor) pprint(api_response) except ApiException as e: print(\"Exception when calling ProcessesApi->list_processes: %s\\n\" % e)","title":"Example"},{"location":"v2/ProcessesApi/#parameters","text":"Name Type Description Notes search str String to search processes by. [optional] tags str Comma-separated list of tags to filter processes by. [optional] _from int 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 int 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 int Maximum number of results returned. [optional] if omitted the server will use the default value of 1000 page_cursor str String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. [optional]","title":"Parameters"},{"location":"v2/ProcessesApi/#return-type","text":"ProcessSummariesResponse","title":"Return type"},{"location":"v2/ProcessesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/ProcessesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/ProcessesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/QuerySortOrder/","text":"QuerySortOrder Direction of sort. Properties Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"QuerySortOrder"},{"location":"v2/QuerySortOrder/#querysortorder","text":"Direction of sort.","title":"QuerySortOrder"},{"location":"v2/QuerySortOrder/#properties","text":"Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentIntegrationMetadataData/","text":"RelationshipToIncidentIntegrationMetadataData A relationship reference for an integration metadata object. Properties Name Type Description Notes id str A unique identifier that represents the integration metadata. type IncidentIntegrationMetadataType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentIntegrationMetadataData"},{"location":"v2/RelationshipToIncidentIntegrationMetadataData/#relationshiptoincidentintegrationmetadatadata","text":"A relationship reference for an integration metadata object.","title":"RelationshipToIncidentIntegrationMetadataData"},{"location":"v2/RelationshipToIncidentIntegrationMetadataData/#properties","text":"Name Type Description Notes id str A unique identifier that represents the integration metadata. type IncidentIntegrationMetadataType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentIntegrationMetadatas/","text":"RelationshipToIncidentIntegrationMetadatas A relationship reference for multiple integration metadata objects. Properties Name Type Description Notes data [RelationshipToIncidentIntegrationMetadataData] The integration metadata relationship array [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentIntegrationMetadatas"},{"location":"v2/RelationshipToIncidentIntegrationMetadatas/#relationshiptoincidentintegrationmetadatas","text":"A relationship reference for multiple integration metadata objects.","title":"RelationshipToIncidentIntegrationMetadatas"},{"location":"v2/RelationshipToIncidentIntegrationMetadatas/#properties","text":"Name Type Description Notes data [RelationshipToIncidentIntegrationMetadataData] The integration metadata relationship array [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentPostmortem/","text":"RelationshipToIncidentPostmortem A relationship reference for postmortems. Properties Name Type Description Notes data RelationshipToIncidentPostmortemData [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentPostmortem"},{"location":"v2/RelationshipToIncidentPostmortem/#relationshiptoincidentpostmortem","text":"A relationship reference for postmortems.","title":"RelationshipToIncidentPostmortem"},{"location":"v2/RelationshipToIncidentPostmortem/#properties","text":"Name Type Description Notes data RelationshipToIncidentPostmortemData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentPostmortemData/","text":"RelationshipToIncidentPostmortemData The postmortem relationship data. Properties Name Type Description Notes id str A unique identifier that represents the postmortem. type IncidentPostmortemType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentPostmortemData"},{"location":"v2/RelationshipToIncidentPostmortemData/#relationshiptoincidentpostmortemdata","text":"The postmortem relationship data.","title":"RelationshipToIncidentPostmortemData"},{"location":"v2/RelationshipToIncidentPostmortemData/#properties","text":"Name Type Description Notes id str A unique identifier that represents the postmortem. type IncidentPostmortemType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToOrganization/","text":"RelationshipToOrganization Relationship to an organization. Properties Name Type Description Notes data RelationshipToOrganizationData [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToOrganization"},{"location":"v2/RelationshipToOrganization/#relationshiptoorganization","text":"Relationship to an organization.","title":"RelationshipToOrganization"},{"location":"v2/RelationshipToOrganization/#properties","text":"Name Type Description Notes data RelationshipToOrganizationData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToOrganizationData/","text":"RelationshipToOrganizationData Relationship to organization object. Properties Name Type Description Notes id str ID of the organization. type OrganizationsType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToOrganizationData"},{"location":"v2/RelationshipToOrganizationData/#relationshiptoorganizationdata","text":"Relationship to organization object.","title":"RelationshipToOrganizationData"},{"location":"v2/RelationshipToOrganizationData/#properties","text":"Name Type Description Notes id str ID of the organization. type OrganizationsType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToOrganizations/","text":"RelationshipToOrganizations Relationship to organizations. Properties Name Type Description Notes data [RelationshipToOrganizationData] Relationships to organization objects. [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToOrganizations"},{"location":"v2/RelationshipToOrganizations/#relationshiptoorganizations","text":"Relationship to organizations.","title":"RelationshipToOrganizations"},{"location":"v2/RelationshipToOrganizations/#properties","text":"Name Type Description Notes data [RelationshipToOrganizationData] Relationships to organization objects. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToPermission/","text":"RelationshipToPermission Relationship to a permissions object. Properties Name Type Description Notes data RelationshipToPermissionData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToPermission"},{"location":"v2/RelationshipToPermission/#relationshiptopermission","text":"Relationship to a permissions object.","title":"RelationshipToPermission"},{"location":"v2/RelationshipToPermission/#properties","text":"Name Type Description Notes data RelationshipToPermissionData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToPermissionData/","text":"RelationshipToPermissionData Relationship to permission object. Properties Name Type Description Notes id str ID of the permission. [optional] type PermissionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToPermissionData"},{"location":"v2/RelationshipToPermissionData/#relationshiptopermissiondata","text":"Relationship to permission object.","title":"RelationshipToPermissionData"},{"location":"v2/RelationshipToPermissionData/#properties","text":"Name Type Description Notes id str ID of the permission. [optional] type PermissionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToPermissions/","text":"RelationshipToPermissions Relationship to multiple permissions objects. Properties Name Type Description Notes data [RelationshipToPermissionData] Relationships to permission objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToPermissions"},{"location":"v2/RelationshipToPermissions/#relationshiptopermissions","text":"Relationship to multiple permissions objects.","title":"RelationshipToPermissions"},{"location":"v2/RelationshipToPermissions/#properties","text":"Name Type Description Notes data [RelationshipToPermissionData] Relationships to permission objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToRole/","text":"RelationshipToRole Relationship to role. Properties Name Type Description Notes data RelationshipToRoleData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToRole"},{"location":"v2/RelationshipToRole/#relationshiptorole","text":"Relationship to role.","title":"RelationshipToRole"},{"location":"v2/RelationshipToRole/#properties","text":"Name Type Description Notes data RelationshipToRoleData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToRoleData/","text":"RelationshipToRoleData Relationship to role object. Properties Name Type Description Notes id str ID of the role. [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToRoleData"},{"location":"v2/RelationshipToRoleData/#relationshiptoroledata","text":"Relationship to role object.","title":"RelationshipToRoleData"},{"location":"v2/RelationshipToRoleData/#properties","text":"Name Type Description Notes id str ID of the role. [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToRoles/","text":"RelationshipToRoles Relationship to roles. Properties Name Type Description Notes data [RelationshipToRoleData] An array containing type and ID of a role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToRoles"},{"location":"v2/RelationshipToRoles/#relationshiptoroles","text":"Relationship to roles.","title":"RelationshipToRoles"},{"location":"v2/RelationshipToRoles/#properties","text":"Name Type Description Notes data [RelationshipToRoleData] An array containing type and ID of a role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToUser/","text":"RelationshipToUser Relationship to user. Properties Name Type Description Notes data RelationshipToUserData [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToUser"},{"location":"v2/RelationshipToUser/#relationshiptouser","text":"Relationship to user.","title":"RelationshipToUser"},{"location":"v2/RelationshipToUser/#properties","text":"Name Type Description Notes data RelationshipToUserData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToUserData/","text":"RelationshipToUserData Relationship to user object. Properties Name Type Description Notes id str A unique identifier that represents the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToUserData"},{"location":"v2/RelationshipToUserData/#relationshiptouserdata","text":"Relationship to user object.","title":"RelationshipToUserData"},{"location":"v2/RelationshipToUserData/#properties","text":"Name Type Description Notes id str A unique identifier that represents the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToUsers/","text":"RelationshipToUsers Relationship to users. Properties Name Type Description Notes data [RelationshipToUserData] Relationships to user objects. [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToUsers"},{"location":"v2/RelationshipToUsers/#relationshiptousers","text":"Relationship to users.","title":"RelationshipToUsers"},{"location":"v2/RelationshipToUsers/#properties","text":"Name Type Description Notes data [RelationshipToUserData] Relationships to user objects. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ResponseMetaAttributes/","text":"ResponseMetaAttributes Object describing meta attributes of response. Properties Name Type Description Notes page Pagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ResponseMetaAttributes"},{"location":"v2/ResponseMetaAttributes/#responsemetaattributes","text":"Object describing meta attributes of response.","title":"ResponseMetaAttributes"},{"location":"v2/ResponseMetaAttributes/#properties","text":"Name Type Description Notes page Pagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Role/","text":"Role Role object returned by the API. Properties Name Type Description Notes type RolesType attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Role"},{"location":"v2/Role/#role","text":"Role object returned by the API.","title":"Role"},{"location":"v2/Role/#properties","text":"Name Type Description Notes type RolesType attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleAttributes/","text":"RoleAttributes Attributes of the role. Properties Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] user_count int Number of users with that role. optional [Back to Model list] [Back to API list] [Back to README]","title":"RoleAttributes"},{"location":"v2/RoleAttributes/#roleattributes","text":"Attributes of the role.","title":"RoleAttributes"},{"location":"v2/RoleAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] user_count int Number of users with that role. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateAttributes/","text":"RoleCreateAttributes Attributes of the created role. Properties Name Type Description Notes name str Name of the role. created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateAttributes"},{"location":"v2/RoleCreateAttributes/#rolecreateattributes","text":"Attributes of the created role.","title":"RoleCreateAttributes"},{"location":"v2/RoleCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the role. created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateData/","text":"RoleCreateData Data related to the creation of a role. Properties Name Type Description Notes attributes RoleCreateAttributes relationships RoleRelationships [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateData"},{"location":"v2/RoleCreateData/#rolecreatedata","text":"Data related to the creation of a role.","title":"RoleCreateData"},{"location":"v2/RoleCreateData/#properties","text":"Name Type Description Notes attributes RoleCreateAttributes relationships RoleRelationships [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateRequest/","text":"RoleCreateRequest Create a role. Properties Name Type Description Notes data RoleCreateData [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateRequest"},{"location":"v2/RoleCreateRequest/#rolecreaterequest","text":"Create a role.","title":"RoleCreateRequest"},{"location":"v2/RoleCreateRequest/#properties","text":"Name Type Description Notes data RoleCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateResponse/","text":"RoleCreateResponse Response containing information about a created role. Properties Name Type Description Notes data RoleCreateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateResponse"},{"location":"v2/RoleCreateResponse/#rolecreateresponse","text":"Response containing information about a created role.","title":"RoleCreateResponse"},{"location":"v2/RoleCreateResponse/#properties","text":"Name Type Description Notes data RoleCreateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateResponseData/","text":"RoleCreateResponseData Role object returned by the API. Properties Name Type Description Notes type RolesType attributes RoleCreateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateResponseData"},{"location":"v2/RoleCreateResponseData/#rolecreateresponsedata","text":"Role object returned by the API.","title":"RoleCreateResponseData"},{"location":"v2/RoleCreateResponseData/#properties","text":"Name Type Description Notes type RolesType attributes RoleCreateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleRelationships/","text":"RoleRelationships Relationships of the role object. Properties Name Type Description Notes permissions RelationshipToPermissions [optional] users RelationshipToUsers [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleRelationships"},{"location":"v2/RoleRelationships/#rolerelationships","text":"Relationships of the role object.","title":"RoleRelationships"},{"location":"v2/RoleRelationships/#properties","text":"Name Type Description Notes permissions RelationshipToPermissions [optional] users RelationshipToUsers [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleResponse/","text":"RoleResponse Response containing information about a single role. Properties Name Type Description Notes data Role [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleResponse"},{"location":"v2/RoleResponse/#roleresponse","text":"Response containing information about a single role.","title":"RoleResponse"},{"location":"v2/RoleResponse/#properties","text":"Name Type Description Notes data Role [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleResponseRelationships/","text":"RoleResponseRelationships Relationships of the role object returned by the API. Properties Name Type Description Notes permissions RelationshipToPermissions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleResponseRelationships"},{"location":"v2/RoleResponseRelationships/#roleresponserelationships","text":"Relationships of the role object returned by the API.","title":"RoleResponseRelationships"},{"location":"v2/RoleResponseRelationships/#properties","text":"Name Type Description Notes permissions RelationshipToPermissions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateAttributes/","text":"RoleUpdateAttributes Attributes of the role. Properties Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateAttributes"},{"location":"v2/RoleUpdateAttributes/#roleupdateattributes","text":"Attributes of the role.","title":"RoleUpdateAttributes"},{"location":"v2/RoleUpdateAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateData/","text":"RoleUpdateData Data related to the update of a role. Properties Name Type Description Notes attributes RoleUpdateAttributes id str ID of the role. type RolesType [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateData"},{"location":"v2/RoleUpdateData/#roleupdatedata","text":"Data related to the update of a role.","title":"RoleUpdateData"},{"location":"v2/RoleUpdateData/#properties","text":"Name Type Description Notes attributes RoleUpdateAttributes id str ID of the role. type RolesType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateRequest/","text":"RoleUpdateRequest Update a role. Properties Name Type Description Notes data RoleUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateRequest"},{"location":"v2/RoleUpdateRequest/#roleupdaterequest","text":"Update a role.","title":"RoleUpdateRequest"},{"location":"v2/RoleUpdateRequest/#properties","text":"Name Type Description Notes data RoleUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateResponse/","text":"RoleUpdateResponse Response containing information about an updated role. Properties Name Type Description Notes data RoleUpdateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateResponse"},{"location":"v2/RoleUpdateResponse/#roleupdateresponse","text":"Response containing information about an updated role.","title":"RoleUpdateResponse"},{"location":"v2/RoleUpdateResponse/#properties","text":"Name Type Description Notes data RoleUpdateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateResponseData/","text":"RoleUpdateResponseData Role object returned by the API. Properties Name Type Description Notes type RolesType attributes RoleUpdateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateResponseData"},{"location":"v2/RoleUpdateResponseData/#roleupdateresponsedata","text":"Role object returned by the API.","title":"RoleUpdateResponseData"},{"location":"v2/RoleUpdateResponseData/#properties","text":"Name Type Description Notes type RolesType attributes RoleUpdateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RolesApi/","text":"datadog_api_client.v2.RolesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role create_role POST /api/v2/roles Create role delete_role DELETE /api/v2/roles/{role_id} Delete role get_role GET /api/v2/roles/{role_id} Get a role list_permissions GET /api/v2/permissions List permissions list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role list_roles GET /api/v2/roles List roles remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role update_role PATCH /api/v2/roles/{role_id} Update a role add_permission_to_role PermissionsResponse add_permission_to_role(role_id, body) Grant permission to a role Adds a permission to a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Grant permission to a role api_response = api_instance.add_permission_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_permission_to_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] add_user_to_role UsersResponse add_user_to_role(role_id, body) Add a user to a role Adds a user to a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Add a user to a role api_response = api_instance.add_user_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_user_to_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToUser Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_role RoleCreateResponse create_role(body) Create role Create a new role for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) body = RoleCreateRequest( data=RoleCreateData( attributes=RoleCreateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"developers\", ), relationships=RoleRelationships( permissions=RelationshipToPermissions( data=[ RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ], ), users=RelationshipToUsers( data=[ RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ], ), ), type=RolesType(\"roles\"), ), ) # RoleCreateRequest | # example passing only required values which don't have defaults set try: # Create role api_response = api_instance.create_role(body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->create_role: %s\\n\" % e) Parameters Name Type Description Notes body RoleCreateRequest Return type RoleCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_role delete_role(role_id) Delete role Disables a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Delete role api_instance.delete_role(role_id) except ApiException as e: print(\"Exception when calling RolesApi->delete_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_role RoleResponse get_role(role_id) Get a role Get a role in the organization specified by the role\u2019s role_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Get a role api_response = api_instance.get_role(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->get_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. Return type RoleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_permissions PermissionsResponse list_permissions() List permissions Returns a list of all permissions, including name, description, and ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) # example, this endpoint has no required or optional parameters try: # List permissions api_response = api_instance.list_permissions() pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_permissions: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_role_permissions PermissionsResponse list_role_permissions(role_id) List permissions for a role Returns a list of all permissions for a single role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # List permissions for a role api_response = api_instance.list_role_permissions(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_permissions: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_role_users UsersResponse list_role_users(role_id) Get all users of a role Gets all users of a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set try: # Get all users of a role api_response = api_instance.list_role_users(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get all users of a role api_response = api_instance.list_role_users(role_id, page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" filter str Filter all users by the given string. Defaults to no filtering. [optional] Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_roles RolesResponse list_roles() List roles Returns all roles, including their names and IDs. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = RolesSort(\"name\") # 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) filter = \"filter_example\" # str | Filter all roles by the given string. (optional) # example passing only required values which don't have defaults set # and optional values try: # List roles api_response = api_instance.list_roles(page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_roles: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter all roles by the given string. [optional] Return type RolesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_permission_from_role PermissionsResponse remove_permission_from_role(role_id, body) Revoke permission Removes a permission from a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Revoke permission api_response = api_instance.remove_permission_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_permission_from_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_user_from_role UsersResponse remove_user_from_role(role_id, body) Remove a user from a role Removes a user from a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Remove a user from a role api_response = api_instance.remove_user_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_user_from_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToUser Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_role RoleUpdateResponse update_role(role_id, body) Update a role Edit a role. Can only be used with application keys belonging to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RoleUpdateRequest( data=RoleUpdateData( attributes=RoleUpdateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=RolesType(\"roles\"), ), ) # RoleUpdateRequest | # example passing only required values which don't have defaults set try: # Update a role api_response = api_instance.update_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->update_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RoleUpdateRequest Return type RoleUpdateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.RolesApi"},{"location":"v2/RolesApi/#datadog_api_clientv2rolesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role create_role POST /api/v2/roles Create role delete_role DELETE /api/v2/roles/{role_id} Delete role get_role GET /api/v2/roles/{role_id} Get a role list_permissions GET /api/v2/permissions List permissions list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role list_roles GET /api/v2/roles List roles remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role update_role PATCH /api/v2/roles/{role_id} Update a role","title":"datadog_api_client.v2.RolesApi"},{"location":"v2/RolesApi/#add_permission_to_role","text":"PermissionsResponse add_permission_to_role(role_id, body) Grant permission to a role Adds a permission to a role.","title":"add_permission_to_role"},{"location":"v2/RolesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Grant permission to a role api_response = api_instance.add_permission_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_permission_to_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission","title":"Parameters"},{"location":"v2/RolesApi/#return-type","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#add_user_to_role","text":"UsersResponse add_user_to_role(role_id, body) Add a user to a role Adds a user to a role.","title":"add_user_to_role"},{"location":"v2/RolesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Add a user to a role api_response = api_instance.add_user_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_user_to_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_1","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToUser","title":"Parameters"},{"location":"v2/RolesApi/#return-type_1","text":"UsersResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#create_role","text":"RoleCreateResponse create_role(body) Create role Create a new role for your organization.","title":"create_role"},{"location":"v2/RolesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) body = RoleCreateRequest( data=RoleCreateData( attributes=RoleCreateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"developers\", ), relationships=RoleRelationships( permissions=RelationshipToPermissions( data=[ RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ], ), users=RelationshipToUsers( data=[ RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ], ), ), type=RolesType(\"roles\"), ), ) # RoleCreateRequest | # example passing only required values which don't have defaults set try: # Create role api_response = api_instance.create_role(body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->create_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_2","text":"Name Type Description Notes body RoleCreateRequest","title":"Parameters"},{"location":"v2/RolesApi/#return-type_2","text":"RoleCreateResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#delete_role","text":"delete_role(role_id) Delete role Disables a role.","title":"delete_role"},{"location":"v2/RolesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Delete role api_instance.delete_role(role_id) except ApiException as e: print(\"Exception when calling RolesApi->delete_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_3","text":"Name Type Description Notes role_id str The ID of the role.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v2/RolesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_3","text":"Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#get_role","text":"RoleResponse get_role(role_id) Get a role Get a role in the organization specified by the role\u2019s role_id .","title":"get_role"},{"location":"v2/RolesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Get a role api_response = api_instance.get_role(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->get_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_4","text":"Name Type Description Notes role_id str The ID of the role.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_4","text":"RoleResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_permissions","text":"PermissionsResponse list_permissions() List permissions Returns a list of all permissions, including name, description, and ID.","title":"list_permissions"},{"location":"v2/RolesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) # example, this endpoint has no required or optional parameters try: # List permissions api_response = api_instance.list_permissions() pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_permissions: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_5","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_5","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_role_permissions","text":"PermissionsResponse list_role_permissions(role_id) List permissions for a role Returns a list of all permissions for a single role.","title":"list_role_permissions"},{"location":"v2/RolesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # List permissions for a role api_response = api_instance.list_role_permissions(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_permissions: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_6","text":"Name Type Description Notes role_id str The ID of the role.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_6","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_role_users","text":"UsersResponse list_role_users(role_id) Get all users of a role Gets all users of a role.","title":"list_role_users"},{"location":"v2/RolesApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set try: # Get all users of a role api_response = api_instance.list_role_users(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get all users of a role api_response = api_instance.list_role_users(role_id, page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_7","text":"Name Type Description Notes role_id str The ID of the role. page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" filter str Filter all users by the given string. Defaults to no filtering. [optional]","title":"Parameters"},{"location":"v2/RolesApi/#return-type_7","text":"UsersResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_roles","text":"RolesResponse list_roles() List roles Returns all roles, including their names and IDs.","title":"list_roles"},{"location":"v2/RolesApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = RolesSort(\"name\") # 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) filter = \"filter_example\" # str | Filter all roles by the given string. (optional) # example passing only required values which don't have defaults set # and optional values try: # List roles api_response = api_instance.list_roles(page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_roles: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_8","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter all roles by the given string. [optional]","title":"Parameters"},{"location":"v2/RolesApi/#return-type_8","text":"RolesResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#remove_permission_from_role","text":"PermissionsResponse remove_permission_from_role(role_id, body) Revoke permission Removes a permission from a role.","title":"remove_permission_from_role"},{"location":"v2/RolesApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Revoke permission api_response = api_instance.remove_permission_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_permission_from_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_9","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission","title":"Parameters"},{"location":"v2/RolesApi/#return-type_9","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_9","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#remove_user_from_role","text":"UsersResponse remove_user_from_role(role_id, body) Remove a user from a role Removes a user from a role.","title":"remove_user_from_role"},{"location":"v2/RolesApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Remove a user from a role api_response = api_instance.remove_user_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_user_from_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_10","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToUser","title":"Parameters"},{"location":"v2/RolesApi/#return-type_10","text":"UsersResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_10","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#update_role","text":"RoleUpdateResponse update_role(role_id, body) Update a role Edit a role. Can only be used with application keys belonging to administrators.","title":"update_role"},{"location":"v2/RolesApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RoleUpdateRequest( data=RoleUpdateData( attributes=RoleUpdateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=RolesType(\"roles\"), ), ) # RoleUpdateRequest | # example passing only required values which don't have defaults set try: # Update a role api_response = api_instance.update_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->update_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_11","text":"Name Type Description Notes role_id str The ID of the role. body RoleUpdateRequest","title":"Parameters"},{"location":"v2/RolesApi/#return-type_11","text":"RoleUpdateResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_11","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesResponse/","text":"RolesResponse Response containing information about multiple roles. Properties Name Type Description Notes data [Role] Array of returned roles. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RolesResponse"},{"location":"v2/RolesResponse/#rolesresponse","text":"Response containing information about multiple roles.","title":"RolesResponse"},{"location":"v2/RolesResponse/#properties","text":"Name Type Description Notes data [Role] Array of returned roles. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RolesSort/","text":"RolesSort Sorting options for roles. Properties Name Type Description Notes value str Sorting options for roles. defaults to \"name\", must be one of [\"name\", \"-name\", \"modified_at\", \"-modified_at\", \"user_count\", \"-user_count\", ] [Back to Model list] [Back to API list] [Back to README]","title":"RolesSort"},{"location":"v2/RolesSort/#rolessort","text":"Sorting options for roles.","title":"RolesSort"},{"location":"v2/RolesSort/#properties","text":"Name Type Description Notes value str Sorting options for roles. defaults to \"name\", must be one of [\"name\", \"-name\", \"modified_at\", \"-modified_at\", \"user_count\", \"-user_count\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RolesType/","text":"RolesType Roles type. Properties Name Type Description Notes value str Roles type. defaults to \"roles\", must be one of [\"roles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"RolesType"},{"location":"v2/RolesType/#rolestype","text":"Roles type.","title":"RolesType"},{"location":"v2/RolesType/#properties","text":"Name Type Description Notes value str Roles type. defaults to \"roles\", must be one of [\"roles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringApi/","text":"datadog_api_client.v2.SecurityMonitoringApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule create_security_monitoring_rule SecurityMonitoringRuleResponse create_security_monitoring_rule(body) Create a detection rule Create a detection rule. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringRuleCreatePayload( cases=[ SecurityMonitoringRuleCaseCreate( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"\", name=\"\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQueryCreate( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"a < 3\", ), ], tags=[\"env:prod\",\"team:security\"], ) # SecurityMonitoringRuleCreatePayload | # example passing only required values which don't have defaults set try: # Create a detection rule api_response = api_instance.create_security_monitoring_rule(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->create_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes body SecurityMonitoringRuleCreatePayload Return type SecurityMonitoringRuleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_security_monitoring_rule delete_security_monitoring_rule(rule_id) Delete an existing rule Delete an existing rule. Default rules cannot be deleted. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Delete an existing rule api_instance.delete_security_monitoring_rule(rule_id) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->delete_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes rule_id str The ID of the rule. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_security_monitoring_rule SecurityMonitoringRuleResponse get_security_monitoring_rule(rule_id) Get a rule's details Get a rule's details. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Get a rule's details api_response = api_instance.get_security_monitoring_rule(rule_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->get_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes rule_id str The ID of the rule. Return type SecurityMonitoringRuleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_security_monitoring_rules SecurityMonitoringListRulesResponse list_security_monitoring_rules() List rules List rules. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # List rules api_response = api_instance.list_security_monitoring_rules(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_rules: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 Return type SecurityMonitoringListRulesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_security_monitoring_signals SecurityMonitoringSignalsListResponse list_security_monitoring_signals() Get a quick list of security signals The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) filter_query = \"security:attack status:high\" # str | The search query for security signals. (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | The minimum timestamp for requested security signals. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | The maximum timestamp for requested security signals. (optional) sort = SecurityMonitoringSignalsSort(\"timestamp\") # SecurityMonitoringSignalsSort | The order of the security signals in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | A list of results using the cursor provided in the previous query. (optional) page_limit = 25 # int | The maximum number of security signals in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a quick list of security signals api_response = api_instance.list_security_monitoring_signals(filter_query=filter_query, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_signals: %s\\n\" % e) Parameters Name Type Description Notes filter_query str The search query for security signals. [optional] filter_from datetime The minimum timestamp for requested security signals. [optional] filter_to datetime The maximum timestamp for requested security signals. [optional] sort SecurityMonitoringSignalsSort The order of the security signals in results. [optional] page_cursor str A list of results using the cursor provided in the previous query. [optional] page_limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10 Return type SecurityMonitoringSignalsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] search_security_monitoring_signals SecurityMonitoringSignalsListResponse search_security_monitoring_signals() Get a list of security signals Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing security signals. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"search_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringSignalListRequest( filter=SecurityMonitoringSignalListRequestFilter( _from=dateutil_parser('2019-01-02T09:42:36.32Z'), query=\"security:attack status:high\", to=dateutil_parser('2019-01-03T09:42:36.32Z'), ), page=SecurityMonitoringSignalListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=SecurityMonitoringSignalsSort(\"timestamp\"), ) # SecurityMonitoringSignalListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of security signals api_response = api_instance.search_security_monitoring_signals(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->search_security_monitoring_signals: %s\\n\" % e) Parameters Name Type Description Notes body SecurityMonitoringSignalListRequest [optional] Return type SecurityMonitoringSignalsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_security_monitoring_rule SecurityMonitoringRuleResponse update_security_monitoring_rule(rule_id, body) Update an existing rule Update an existing rule. When updating cases , queries or options , the whole field must be included. For example, when modifying a query all queries must be included. Default rules can only be updated to be enabled and to change notifications. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. body = SecurityMonitoringRuleUpdatePayload( cases=[ SecurityMonitoringRuleCase( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"message_example\", name=\"name_example\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQuery( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"query_example\", ), ], tags=[ \"tags_example\", ], ) # SecurityMonitoringRuleUpdatePayload | # example passing only required values which don't have defaults set try: # Update an existing rule api_response = api_instance.update_security_monitoring_rule(rule_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->update_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes rule_id str The ID of the rule. body SecurityMonitoringRuleUpdatePayload Return type SecurityMonitoringRuleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Concurrent Modification - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.SecurityMonitoringApi"},{"location":"v2/SecurityMonitoringApi/#datadog_api_clientv2securitymonitoringapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule","title":"datadog_api_client.v2.SecurityMonitoringApi"},{"location":"v2/SecurityMonitoringApi/#create_security_monitoring_rule","text":"SecurityMonitoringRuleResponse create_security_monitoring_rule(body) Create a detection rule Create a detection rule.","title":"create_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringRuleCreatePayload( cases=[ SecurityMonitoringRuleCaseCreate( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"\", name=\"\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQueryCreate( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"a < 3\", ), ], tags=[\"env:prod\",\"team:security\"], ) # SecurityMonitoringRuleCreatePayload | # example passing only required values which don't have defaults set try: # Create a detection rule api_response = api_instance.create_security_monitoring_rule(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->create_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters","text":"Name Type Description Notes body SecurityMonitoringRuleCreatePayload","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type","text":"SecurityMonitoringRuleResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#delete_security_monitoring_rule","text":"delete_security_monitoring_rule(rule_id) Delete an existing rule Delete an existing rule. Default rules cannot be deleted.","title":"delete_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Delete an existing rule api_instance.delete_security_monitoring_rule(rule_id) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->delete_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_1","text":"Name Type Description Notes rule_id str The ID of the rule.","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#get_security_monitoring_rule","text":"SecurityMonitoringRuleResponse get_security_monitoring_rule(rule_id) Get a rule's details Get a rule's details.","title":"get_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Get a rule's details api_response = api_instance.get_security_monitoring_rule(rule_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->get_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_2","text":"Name Type Description Notes rule_id str The ID of the rule.","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_2","text":"SecurityMonitoringRuleResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#list_security_monitoring_rules","text":"SecurityMonitoringListRulesResponse list_security_monitoring_rules() List rules List rules.","title":"list_security_monitoring_rules"},{"location":"v2/SecurityMonitoringApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # List rules api_response = api_instance.list_security_monitoring_rules(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_rules: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_3","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_3","text":"SecurityMonitoringListRulesResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#list_security_monitoring_signals","text":"SecurityMonitoringSignalsListResponse list_security_monitoring_signals() Get a quick list of security signals The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals.","title":"list_security_monitoring_signals"},{"location":"v2/SecurityMonitoringApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) filter_query = \"security:attack status:high\" # str | The search query for security signals. (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | The minimum timestamp for requested security signals. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | The maximum timestamp for requested security signals. (optional) sort = SecurityMonitoringSignalsSort(\"timestamp\") # SecurityMonitoringSignalsSort | The order of the security signals in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | A list of results using the cursor provided in the previous query. (optional) page_limit = 25 # int | The maximum number of security signals in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a quick list of security signals api_response = api_instance.list_security_monitoring_signals(filter_query=filter_query, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_signals: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_4","text":"Name Type Description Notes filter_query str The search query for security signals. [optional] filter_from datetime The minimum timestamp for requested security signals. [optional] filter_to datetime The maximum timestamp for requested security signals. [optional] sort SecurityMonitoringSignalsSort The order of the security signals in results. [optional] page_cursor str A list of results using the cursor provided in the previous query. [optional] page_limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_4","text":"SecurityMonitoringSignalsListResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#search_security_monitoring_signals","text":"SecurityMonitoringSignalsListResponse search_security_monitoring_signals() Get a list of security signals Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing security signals.","title":"search_security_monitoring_signals"},{"location":"v2/SecurityMonitoringApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"search_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringSignalListRequest( filter=SecurityMonitoringSignalListRequestFilter( _from=dateutil_parser('2019-01-02T09:42:36.32Z'), query=\"security:attack status:high\", to=dateutil_parser('2019-01-03T09:42:36.32Z'), ), page=SecurityMonitoringSignalListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=SecurityMonitoringSignalsSort(\"timestamp\"), ) # SecurityMonitoringSignalListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of security signals api_response = api_instance.search_security_monitoring_signals(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->search_security_monitoring_signals: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_5","text":"Name Type Description Notes body SecurityMonitoringSignalListRequest [optional]","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_5","text":"SecurityMonitoringSignalsListResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#update_security_monitoring_rule","text":"SecurityMonitoringRuleResponse update_security_monitoring_rule(rule_id, body) Update an existing rule Update an existing rule. When updating cases , queries or options , the whole field must be included. For example, when modifying a query all queries must be included. Default rules can only be updated to be enabled and to change notifications.","title":"update_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. body = SecurityMonitoringRuleUpdatePayload( cases=[ SecurityMonitoringRuleCase( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"message_example\", name=\"name_example\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQuery( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"query_example\", ), ], tags=[ \"tags_example\", ], ) # SecurityMonitoringRuleUpdatePayload | # example passing only required values which don't have defaults set try: # Update an existing rule api_response = api_instance.update_security_monitoring_rule(rule_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->update_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_6","text":"Name Type Description Notes rule_id str The ID of the rule. body SecurityMonitoringRuleUpdatePayload","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_6","text":"SecurityMonitoringRuleResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Concurrent Modification - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringFilter/","text":"SecurityMonitoringFilter The rule's suppression filter. Properties Name Type Description Notes action SecurityMonitoringFilterAction [optional] query str Query for selecting logs to apply the filtering action. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringFilter"},{"location":"v2/SecurityMonitoringFilter/#securitymonitoringfilter","text":"The rule's suppression filter.","title":"SecurityMonitoringFilter"},{"location":"v2/SecurityMonitoringFilter/#properties","text":"Name Type Description Notes action SecurityMonitoringFilterAction [optional] query str Query for selecting logs to apply the filtering action. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringFilterAction/","text":"SecurityMonitoringFilterAction The type of filtering action. Properties Name Type Description Notes value str The type of filtering action. must be one of [\"require\", \"suppress\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringFilterAction"},{"location":"v2/SecurityMonitoringFilterAction/#securitymonitoringfilteraction","text":"The type of filtering action.","title":"SecurityMonitoringFilterAction"},{"location":"v2/SecurityMonitoringFilterAction/#properties","text":"Name Type Description Notes value str The type of filtering action. must be one of [\"require\", \"suppress\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringListRulesResponse/","text":"SecurityMonitoringListRulesResponse List of rules. Properties Name Type Description Notes data [SecurityMonitoringRuleResponse] TODO. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringListRulesResponse"},{"location":"v2/SecurityMonitoringListRulesResponse/#securitymonitoringlistrulesresponse","text":"List of rules.","title":"SecurityMonitoringListRulesResponse"},{"location":"v2/SecurityMonitoringListRulesResponse/#properties","text":"Name Type Description Notes data [SecurityMonitoringRuleResponse] TODO. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleCase/","text":"SecurityMonitoringRuleCase Case when signal is generated. Properties Name Type Description Notes condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] status SecurityMonitoringRuleSeverity [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleCase"},{"location":"v2/SecurityMonitoringRuleCase/#securitymonitoringrulecase","text":"Case when signal is generated.","title":"SecurityMonitoringRuleCase"},{"location":"v2/SecurityMonitoringRuleCase/#properties","text":"Name Type Description Notes condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] status SecurityMonitoringRuleSeverity [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleCaseCreate/","text":"SecurityMonitoringRuleCaseCreate Case when signal is generated. Properties Name Type Description Notes status SecurityMonitoringRuleSeverity condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleCaseCreate"},{"location":"v2/SecurityMonitoringRuleCaseCreate/#securitymonitoringrulecasecreate","text":"Case when signal is generated.","title":"SecurityMonitoringRuleCaseCreate"},{"location":"v2/SecurityMonitoringRuleCaseCreate/#properties","text":"Name Type Description Notes status SecurityMonitoringRuleSeverity condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleCreatePayload/","text":"SecurityMonitoringRuleCreatePayload Create a new rule. Properties Name Type Description Notes cases [SecurityMonitoringRuleCaseCreate] Cases for generating signals. is_enabled bool Whether the rule is enabled. message str Message for generated signals. name str The name of the rule. options SecurityMonitoringRuleOptions queries [SecurityMonitoringRuleQueryCreate] Queries for selecting logs which are part of the rule. filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleCreatePayload"},{"location":"v2/SecurityMonitoringRuleCreatePayload/#securitymonitoringrulecreatepayload","text":"Create a new rule.","title":"SecurityMonitoringRuleCreatePayload"},{"location":"v2/SecurityMonitoringRuleCreatePayload/#properties","text":"Name Type Description Notes cases [SecurityMonitoringRuleCaseCreate] Cases for generating signals. is_enabled bool Whether the rule is enabled. message str Message for generated signals. name str The name of the rule. options SecurityMonitoringRuleOptions queries [SecurityMonitoringRuleQueryCreate] Queries for selecting logs which are part of the rule. filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleDetectionMethod/","text":"SecurityMonitoringRuleDetectionMethod The detection method. Properties Name Type Description Notes value str The detection method. must be one of [\"threshold\", \"new_value\", \"anomaly_detection\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleDetectionMethod"},{"location":"v2/SecurityMonitoringRuleDetectionMethod/#securitymonitoringruledetectionmethod","text":"The detection method.","title":"SecurityMonitoringRuleDetectionMethod"},{"location":"v2/SecurityMonitoringRuleDetectionMethod/#properties","text":"Name Type Description Notes value str The detection method. must be one of [\"threshold\", \"new_value\", \"anomaly_detection\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleEvaluationWindow/","text":"SecurityMonitoringRuleEvaluationWindow A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. Properties Name Type Description Notes value int A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleEvaluationWindow"},{"location":"v2/SecurityMonitoringRuleEvaluationWindow/#securitymonitoringruleevaluationwindow","text":"A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time.","title":"SecurityMonitoringRuleEvaluationWindow"},{"location":"v2/SecurityMonitoringRuleEvaluationWindow/#properties","text":"Name Type Description Notes value int A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleKeepAlive/","text":"SecurityMonitoringRuleKeepAlive Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window. Properties Name Type Description Notes value int Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleKeepAlive"},{"location":"v2/SecurityMonitoringRuleKeepAlive/#securitymonitoringrulekeepalive","text":"Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window.","title":"SecurityMonitoringRuleKeepAlive"},{"location":"v2/SecurityMonitoringRuleKeepAlive/#properties","text":"Name Type Description Notes value int Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleMaxSignalDuration/","text":"SecurityMonitoringRuleMaxSignalDuration A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. Properties Name Type Description Notes value int A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleMaxSignalDuration"},{"location":"v2/SecurityMonitoringRuleMaxSignalDuration/#securitymonitoringrulemaxsignalduration","text":"A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.","title":"SecurityMonitoringRuleMaxSignalDuration"},{"location":"v2/SecurityMonitoringRuleMaxSignalDuration/#properties","text":"Name Type Description Notes value int A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleNewValueOptions/","text":"SecurityMonitoringRuleNewValueOptions Options on new value rules. Properties Name Type Description Notes forget_after SecurityMonitoringRuleNewValueOptionsForgetAfter [optional] learning_duration SecurityMonitoringRuleNewValueOptionsLearningDuration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleNewValueOptions"},{"location":"v2/SecurityMonitoringRuleNewValueOptions/#securitymonitoringrulenewvalueoptions","text":"Options on new value rules.","title":"SecurityMonitoringRuleNewValueOptions"},{"location":"v2/SecurityMonitoringRuleNewValueOptions/#properties","text":"Name Type Description Notes forget_after SecurityMonitoringRuleNewValueOptionsForgetAfter [optional] learning_duration SecurityMonitoringRuleNewValueOptionsLearningDuration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/","text":"SecurityMonitoringRuleNewValueOptionsForgetAfter The duration in days after which a learned value is forgotten. Properties Name Type Description Notes value int The duration in days after which a learned value is forgotten. must be one of [1, 2, 7, 14, 21, 28, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleNewValueOptionsForgetAfter"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/#securitymonitoringrulenewvalueoptionsforgetafter","text":"The duration in days after which a learned value is forgotten.","title":"SecurityMonitoringRuleNewValueOptionsForgetAfter"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/#properties","text":"Name Type Description Notes value int The duration in days after which a learned value is forgotten. must be one of [1, 2, 7, 14, 21, 28, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/","text":"SecurityMonitoringRuleNewValueOptionsLearningDuration The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. Properties Name Type Description Notes value int The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. must be one of [0, 1, 7, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleNewValueOptionsLearningDuration"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/#securitymonitoringrulenewvalueoptionslearningduration","text":"The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.","title":"SecurityMonitoringRuleNewValueOptionsLearningDuration"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/#properties","text":"Name Type Description Notes value int The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. must be one of [0, 1, 7, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleOptions/","text":"SecurityMonitoringRuleOptions Options on rules. Properties Name Type Description Notes detection_method SecurityMonitoringRuleDetectionMethod [optional] evaluation_window SecurityMonitoringRuleEvaluationWindow [optional] keep_alive SecurityMonitoringRuleKeepAlive [optional] max_signal_duration SecurityMonitoringRuleMaxSignalDuration [optional] new_value_options SecurityMonitoringRuleNewValueOptions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleOptions"},{"location":"v2/SecurityMonitoringRuleOptions/#securitymonitoringruleoptions","text":"Options on rules.","title":"SecurityMonitoringRuleOptions"},{"location":"v2/SecurityMonitoringRuleOptions/#properties","text":"Name Type Description Notes detection_method SecurityMonitoringRuleDetectionMethod [optional] evaluation_window SecurityMonitoringRuleEvaluationWindow [optional] keep_alive SecurityMonitoringRuleKeepAlive [optional] max_signal_duration SecurityMonitoringRuleMaxSignalDuration [optional] new_value_options SecurityMonitoringRuleNewValueOptions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleQuery/","text":"SecurityMonitoringRuleQuery Query for matching rule. Properties Name Type Description Notes agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] query str Query to run on logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleQuery"},{"location":"v2/SecurityMonitoringRuleQuery/#securitymonitoringrulequery","text":"Query for matching rule.","title":"SecurityMonitoringRuleQuery"},{"location":"v2/SecurityMonitoringRuleQuery/#properties","text":"Name Type Description Notes agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] query str Query to run on logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleQueryAggregation/","text":"SecurityMonitoringRuleQueryAggregation The aggregation type. Properties Name Type Description Notes value str The aggregation type. must be one of [\"count\", \"cardinality\", \"sum\", \"max\", \"new_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleQueryAggregation"},{"location":"v2/SecurityMonitoringRuleQueryAggregation/#securitymonitoringrulequeryaggregation","text":"The aggregation type.","title":"SecurityMonitoringRuleQueryAggregation"},{"location":"v2/SecurityMonitoringRuleQueryAggregation/#properties","text":"Name Type Description Notes value str The aggregation type. must be one of [\"count\", \"cardinality\", \"sum\", \"max\", \"new_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleQueryCreate/","text":"SecurityMonitoringRuleQueryCreate Query for matching rule. Properties Name Type Description Notes query str Query to run on logs. agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleQueryCreate"},{"location":"v2/SecurityMonitoringRuleQueryCreate/#securitymonitoringrulequerycreate","text":"Query for matching rule.","title":"SecurityMonitoringRuleQueryCreate"},{"location":"v2/SecurityMonitoringRuleQueryCreate/#properties","text":"Name Type Description Notes query str Query to run on logs. agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleResponse/","text":"SecurityMonitoringRuleResponse Detection rule. Properties Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] created_at int When the rule was created, timestamp in milliseconds. [optional] creation_author_id int User ID of the user who created the rule. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] id str The ID of the rule. [optional] is_default bool Whether the rule is included by default. [optional] is_deleted bool Whether the rule has been deleted. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str The name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] version int The version of the rule. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleResponse"},{"location":"v2/SecurityMonitoringRuleResponse/#securitymonitoringruleresponse","text":"Detection rule.","title":"SecurityMonitoringRuleResponse"},{"location":"v2/SecurityMonitoringRuleResponse/#properties","text":"Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] created_at int When the rule was created, timestamp in milliseconds. [optional] creation_author_id int User ID of the user who created the rule. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] id str The ID of the rule. [optional] is_default bool Whether the rule is included by default. [optional] is_deleted bool Whether the rule has been deleted. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str The name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] version int The version of the rule. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleSeverity/","text":"SecurityMonitoringRuleSeverity Severity of the Security Signal. Properties Name Type Description Notes value str Severity of the Security Signal. must be one of [\"info\", \"low\", \"medium\", \"high\", \"critical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleSeverity"},{"location":"v2/SecurityMonitoringRuleSeverity/#securitymonitoringruleseverity","text":"Severity of the Security Signal.","title":"SecurityMonitoringRuleSeverity"},{"location":"v2/SecurityMonitoringRuleSeverity/#properties","text":"Name Type Description Notes value str Severity of the Security Signal. must be one of [\"info\", \"low\", \"medium\", \"high\", \"critical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleUpdatePayload/","text":"SecurityMonitoringRuleUpdatePayload Update an existing rule. Properties Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str Name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleUpdatePayload"},{"location":"v2/SecurityMonitoringRuleUpdatePayload/#securitymonitoringruleupdatepayload","text":"Update an existing rule.","title":"SecurityMonitoringRuleUpdatePayload"},{"location":"v2/SecurityMonitoringRuleUpdatePayload/#properties","text":"Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str Name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuntimeAgentRule/","text":"SecurityMonitoringRuntimeAgentRule The Agent rule. Properties Name Type Description Notes agent_rule_id str The Agent rule ID. Must be unique within the rule. [optional] expression str 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] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuntimeAgentRule"},{"location":"v2/SecurityMonitoringRuntimeAgentRule/#securitymonitoringruntimeagentrule","text":"The Agent rule.","title":"SecurityMonitoringRuntimeAgentRule"},{"location":"v2/SecurityMonitoringRuntimeAgentRule/#properties","text":"Name Type Description Notes agent_rule_id str The Agent rule ID. Must be unique within the rule. [optional] expression str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignal/","text":"SecurityMonitoringSignal Object description of a security signal. Properties Name Type Description Notes attributes SecurityMonitoringSignalAttributes [optional] id str The unique ID of the security signal. [optional] type SecurityMonitoringSignalType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignal"},{"location":"v2/SecurityMonitoringSignal/#securitymonitoringsignal","text":"Object description of a security signal.","title":"SecurityMonitoringSignal"},{"location":"v2/SecurityMonitoringSignal/#properties","text":"Name Type Description Notes attributes SecurityMonitoringSignalAttributes [optional] id str The unique ID of the security signal. [optional] type SecurityMonitoringSignalType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalAttributes/","text":"SecurityMonitoringSignalAttributes The object containing all signal attributes and their associated values. Properties Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} A JSON object of attributes in the security signal. [optional] message str The message in the security signal defined by the rule that generated the signal. [optional] tags [bool, date, datetime, dict, float, int, list, str, none_type] An array of tags associated with the security signal. [optional] timestamp datetime The timestamp of the security signal. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalAttributes"},{"location":"v2/SecurityMonitoringSignalAttributes/#securitymonitoringsignalattributes","text":"The object containing all signal attributes and their associated values.","title":"SecurityMonitoringSignalAttributes"},{"location":"v2/SecurityMonitoringSignalAttributes/#properties","text":"Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} A JSON object of attributes in the security signal. [optional] message str The message in the security signal defined by the rule that generated the signal. [optional] tags [bool, date, datetime, dict, float, int, list, str, none_type] An array of tags associated with the security signal. [optional] timestamp datetime The timestamp of the security signal. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalListRequest/","text":"SecurityMonitoringSignalListRequest The request for a security signal list. Properties Name Type Description Notes filter SecurityMonitoringSignalListRequestFilter [optional] page SecurityMonitoringSignalListRequestPage [optional] sort SecurityMonitoringSignalsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalListRequest"},{"location":"v2/SecurityMonitoringSignalListRequest/#securitymonitoringsignallistrequest","text":"The request for a security signal list.","title":"SecurityMonitoringSignalListRequest"},{"location":"v2/SecurityMonitoringSignalListRequest/#properties","text":"Name Type Description Notes filter SecurityMonitoringSignalListRequestFilter [optional] page SecurityMonitoringSignalListRequestPage [optional] sort SecurityMonitoringSignalsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalListRequestFilter/","text":"SecurityMonitoringSignalListRequestFilter Search filters for listing security signals. Properties Name Type Description Notes _from datetime The minimum timestamp for requested security signals. [optional] query str Search query for listing security signals. [optional] to datetime The maximum timestamp for requested security signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalListRequestFilter"},{"location":"v2/SecurityMonitoringSignalListRequestFilter/#securitymonitoringsignallistrequestfilter","text":"Search filters for listing security signals.","title":"SecurityMonitoringSignalListRequestFilter"},{"location":"v2/SecurityMonitoringSignalListRequestFilter/#properties","text":"Name Type Description Notes _from datetime The minimum timestamp for requested security signals. [optional] query str Search query for listing security signals. [optional] to datetime The maximum timestamp for requested security signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalListRequestPage/","text":"SecurityMonitoringSignalListRequestPage The paging attributes for listing security signals. Properties Name Type Description Notes cursor str A list of results using the cursor provided in the previous query. [optional] limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalListRequestPage"},{"location":"v2/SecurityMonitoringSignalListRequestPage/#securitymonitoringsignallistrequestpage","text":"The paging attributes for listing security signals.","title":"SecurityMonitoringSignalListRequestPage"},{"location":"v2/SecurityMonitoringSignalListRequestPage/#properties","text":"Name Type Description Notes cursor str A list of results using the cursor provided in the previous query. [optional] limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalType/","text":"SecurityMonitoringSignalType The type of event. Properties Name Type Description Notes value str The type of event. defaults to \"signal\", must be one of [\"signal\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalType"},{"location":"v2/SecurityMonitoringSignalType/#securitymonitoringsignaltype","text":"The type of event.","title":"SecurityMonitoringSignalType"},{"location":"v2/SecurityMonitoringSignalType/#properties","text":"Name Type Description Notes value str The type of event. defaults to \"signal\", must be one of [\"signal\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponse/","text":"SecurityMonitoringSignalsListResponse The response object with all security signals matching the request and pagination information. Properties Name Type Description Notes data [SecurityMonitoringSignal] An array of security signals matching the request. [optional] links SecurityMonitoringSignalsListResponseLinks [optional] meta SecurityMonitoringSignalsListResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponse"},{"location":"v2/SecurityMonitoringSignalsListResponse/#securitymonitoringsignalslistresponse","text":"The response object with all security signals matching the request and pagination information.","title":"SecurityMonitoringSignalsListResponse"},{"location":"v2/SecurityMonitoringSignalsListResponse/#properties","text":"Name Type Description Notes data [SecurityMonitoringSignal] An array of security signals matching the request. [optional] links SecurityMonitoringSignalsListResponseLinks [optional] meta SecurityMonitoringSignalsListResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponseLinks/","text":"SecurityMonitoringSignalsListResponseLinks Links attributes. Properties Name Type Description Notes next str The link for the next set of results. Note : The request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponseLinks"},{"location":"v2/SecurityMonitoringSignalsListResponseLinks/#securitymonitoringsignalslistresponselinks","text":"Links attributes.","title":"SecurityMonitoringSignalsListResponseLinks"},{"location":"v2/SecurityMonitoringSignalsListResponseLinks/#properties","text":"Name Type Description Notes next str The link for the next set of results. Note : The request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponseMeta/","text":"SecurityMonitoringSignalsListResponseMeta Meta attributes. Properties Name Type Description Notes page SecurityMonitoringSignalsListResponseMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponseMeta"},{"location":"v2/SecurityMonitoringSignalsListResponseMeta/#securitymonitoringsignalslistresponsemeta","text":"Meta attributes.","title":"SecurityMonitoringSignalsListResponseMeta"},{"location":"v2/SecurityMonitoringSignalsListResponseMeta/#properties","text":"Name Type Description Notes page SecurityMonitoringSignalsListResponseMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponseMetaPage/","text":"SecurityMonitoringSignalsListResponseMetaPage Paging attributes. Properties Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponseMetaPage"},{"location":"v2/SecurityMonitoringSignalsListResponseMetaPage/#securitymonitoringsignalslistresponsemetapage","text":"Paging attributes.","title":"SecurityMonitoringSignalsListResponseMetaPage"},{"location":"v2/SecurityMonitoringSignalsListResponseMetaPage/#properties","text":"Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsSort/","text":"SecurityMonitoringSignalsSort The sort parameters used for querying security signals. Properties Name Type Description Notes value str The sort parameters used for querying security signals. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsSort"},{"location":"v2/SecurityMonitoringSignalsSort/#securitymonitoringsignalssort","text":"The sort parameters used for querying security signals.","title":"SecurityMonitoringSignalsSort"},{"location":"v2/SecurityMonitoringSignalsSort/#properties","text":"Name Type Description Notes value str The sort parameters used for querying security signals. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/User/","text":"User User object returned by the API. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"User"},{"location":"v2/User/#user","text":"User object returned by the API.","title":"User"},{"location":"v2/User/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserAttributes/","text":"UserAttributes Attributes of user object returned by the API. Properties Name Type Description Notes created_at datetime Creation time of the user. [optional] disabled bool Whether the user is disabled. [optional] email str Email of the user. [optional] handle str Handle of the user. [optional] icon str URL of the user's icon. [optional] modified_at datetime Time that the user was last modified. [optional] name str Name of the user. [optional] status str Status of the user. [optional] title str Title of the user. [optional] verified bool Whether the user is verified. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserAttributes"},{"location":"v2/UserAttributes/#userattributes","text":"Attributes of user object returned by the API.","title":"UserAttributes"},{"location":"v2/UserAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the user. [optional] disabled bool Whether the user is disabled. [optional] email str Email of the user. [optional] handle str Handle of the user. [optional] icon str URL of the user's icon. [optional] modified_at datetime Time that the user was last modified. [optional] name str Name of the user. [optional] status str Status of the user. [optional] title str Title of the user. [optional] verified bool Whether the user is verified. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserCreateAttributes/","text":"UserCreateAttributes Attributes of the created user. Properties Name Type Description Notes email str The email of the user. name str The name of the user. [optional] title str The title of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserCreateAttributes"},{"location":"v2/UserCreateAttributes/#usercreateattributes","text":"Attributes of the created user.","title":"UserCreateAttributes"},{"location":"v2/UserCreateAttributes/#properties","text":"Name Type Description Notes email str The email of the user. name str The name of the user. [optional] title str The title of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserCreateData/","text":"UserCreateData Object to create a user. Properties Name Type Description Notes attributes UserCreateAttributes type UsersType relationships UserRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserCreateData"},{"location":"v2/UserCreateData/#usercreatedata","text":"Object to create a user.","title":"UserCreateData"},{"location":"v2/UserCreateData/#properties","text":"Name Type Description Notes attributes UserCreateAttributes type UsersType relationships UserRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserCreateRequest/","text":"UserCreateRequest Create a user. Properties Name Type Description Notes data UserCreateData [Back to Model list] [Back to API list] [Back to README]","title":"UserCreateRequest"},{"location":"v2/UserCreateRequest/#usercreaterequest","text":"Create a user.","title":"UserCreateRequest"},{"location":"v2/UserCreateRequest/#properties","text":"Name Type Description Notes data UserCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationData/","text":"UserInvitationData Object to create a user invitation. Properties Name Type Description Notes relationships UserInvitationRelationships type UserInvitationsType [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationData"},{"location":"v2/UserInvitationData/#userinvitationdata","text":"Object to create a user invitation.","title":"UserInvitationData"},{"location":"v2/UserInvitationData/#properties","text":"Name Type Description Notes relationships UserInvitationRelationships type UserInvitationsType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationDataAttributes/","text":"UserInvitationDataAttributes Attributes of a user invitation. Properties Name Type Description Notes created_at datetime Creation time of the user invitation. [optional] expires_at datetime Time of invitation expiration. [optional] invite_type str Type of invitation. [optional] uuid str UUID of the user invitation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationDataAttributes"},{"location":"v2/UserInvitationDataAttributes/#userinvitationdataattributes","text":"Attributes of a user invitation.","title":"UserInvitationDataAttributes"},{"location":"v2/UserInvitationDataAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the user invitation. [optional] expires_at datetime Time of invitation expiration. [optional] invite_type str Type of invitation. [optional] uuid str UUID of the user invitation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationRelationships/","text":"UserInvitationRelationships Relationships data for user invitation. Properties Name Type Description Notes user RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationRelationships"},{"location":"v2/UserInvitationRelationships/#userinvitationrelationships","text":"Relationships data for user invitation.","title":"UserInvitationRelationships"},{"location":"v2/UserInvitationRelationships/#properties","text":"Name Type Description Notes user RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationResponse/","text":"UserInvitationResponse User invitation as returned by the API. Properties Name Type Description Notes data UserInvitationResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationResponse"},{"location":"v2/UserInvitationResponse/#userinvitationresponse","text":"User invitation as returned by the API.","title":"UserInvitationResponse"},{"location":"v2/UserInvitationResponse/#properties","text":"Name Type Description Notes data UserInvitationResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationResponseData/","text":"UserInvitationResponseData Object of a user invitation returned by the API. Properties Name Type Description Notes attributes UserInvitationDataAttributes [optional] id str ID of the user invitation. [optional] type UserInvitationsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationResponseData"},{"location":"v2/UserInvitationResponseData/#userinvitationresponsedata","text":"Object of a user invitation returned by the API.","title":"UserInvitationResponseData"},{"location":"v2/UserInvitationResponseData/#properties","text":"Name Type Description Notes attributes UserInvitationDataAttributes [optional] id str ID of the user invitation. [optional] type UserInvitationsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationsRequest/","text":"UserInvitationsRequest Object to invite users to join the organization. Properties Name Type Description Notes data [UserInvitationData] List of user invitations. [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationsRequest"},{"location":"v2/UserInvitationsRequest/#userinvitationsrequest","text":"Object to invite users to join the organization.","title":"UserInvitationsRequest"},{"location":"v2/UserInvitationsRequest/#properties","text":"Name Type Description Notes data [UserInvitationData] List of user invitations. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationsResponse/","text":"UserInvitationsResponse User invitations as returned by the API. Properties Name Type Description Notes data [UserInvitationResponseData] Array of user invitations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationsResponse"},{"location":"v2/UserInvitationsResponse/#userinvitationsresponse","text":"User invitations as returned by the API.","title":"UserInvitationsResponse"},{"location":"v2/UserInvitationsResponse/#properties","text":"Name Type Description Notes data [UserInvitationResponseData] Array of user invitations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationsType/","text":"UserInvitationsType User invitations type. Properties Name Type Description Notes value str User invitations type. defaults to \"user_invitations\", must be one of [\"user_invitations\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationsType"},{"location":"v2/UserInvitationsType/#userinvitationstype","text":"User invitations type.","title":"UserInvitationsType"},{"location":"v2/UserInvitationsType/#properties","text":"Name Type Description Notes value str User invitations type. defaults to \"user_invitations\", must be one of [\"user_invitations\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserRelationships/","text":"UserRelationships Relationships of the user object. Properties Name Type Description Notes roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserRelationships"},{"location":"v2/UserRelationships/#userrelationships","text":"Relationships of the user object.","title":"UserRelationships"},{"location":"v2/UserRelationships/#properties","text":"Name Type Description Notes roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserResponse/","text":"UserResponse Response containing information about a single user. Properties Name Type Description Notes data User [optional] included [UserResponseIncludedItem] Array of objects related to the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponse"},{"location":"v2/UserResponse/#userresponse","text":"Response containing information about a single user.","title":"UserResponse"},{"location":"v2/UserResponse/#properties","text":"Name Type Description Notes data User [optional] included [UserResponseIncludedItem] Array of objects related to the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserResponseIncludedItem/","text":"UserResponseIncludedItem An object related to a user. Properties Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponseIncludedItem"},{"location":"v2/UserResponseIncludedItem/#userresponseincludeditem","text":"An object related to a user.","title":"UserResponseIncludedItem"},{"location":"v2/UserResponseIncludedItem/#properties","text":"Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserResponseRelationships/","text":"UserResponseRelationships Relationships of the user object returned by the API. Properties Name Type Description Notes org RelationshipToOrganization [optional] other_orgs RelationshipToOrganizations [optional] other_users RelationshipToUsers [optional] roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponseRelationships"},{"location":"v2/UserResponseRelationships/#userresponserelationships","text":"Relationships of the user object returned by the API.","title":"UserResponseRelationships"},{"location":"v2/UserResponseRelationships/#properties","text":"Name Type Description Notes org RelationshipToOrganization [optional] other_orgs RelationshipToOrganizations [optional] other_users RelationshipToUsers [optional] roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserUpdateAttributes/","text":"UserUpdateAttributes Attributes of the edited user. Properties Name Type Description Notes disabled bool If the user is enabled or disabled. [optional] email str The email of the user. [optional] name str The name of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserUpdateAttributes"},{"location":"v2/UserUpdateAttributes/#userupdateattributes","text":"Attributes of the edited user.","title":"UserUpdateAttributes"},{"location":"v2/UserUpdateAttributes/#properties","text":"Name Type Description Notes disabled bool If the user is enabled or disabled. [optional] email str The email of the user. [optional] name str The name of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserUpdateData/","text":"UserUpdateData Object to update a user. Properties Name Type Description Notes attributes UserUpdateAttributes id str ID of the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"UserUpdateData"},{"location":"v2/UserUpdateData/#userupdatedata","text":"Object to update a user.","title":"UserUpdateData"},{"location":"v2/UserUpdateData/#properties","text":"Name Type Description Notes attributes UserUpdateAttributes id str ID of the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserUpdateRequest/","text":"UserUpdateRequest Update a user. Properties Name Type Description Notes data UserUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"UserUpdateRequest"},{"location":"v2/UserUpdateRequest/#userupdaterequest","text":"Update a user.","title":"UserUpdateRequest"},{"location":"v2/UserUpdateRequest/#properties","text":"Name Type Description Notes data UserUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UsersApi/","text":"datadog_api_client.v2.UsersApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v2/users Create a user disable_user DELETE /api/v2/users/{user_id} Disable a user get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation get_user GET /api/v2/users/{user_id} Get user details list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions list_users GET /api/v2/users List all users send_invitations POST /api/v2/user_invitations Send invitation emails update_user PATCH /api/v2/users/{user_id} Update a user create_user UserResponse create_user(body) Create a user Create a user for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserCreateRequest( data=UserCreateData( attributes=UserCreateAttributes( email=\"jane.doe@example.com\", name=\"name_example\", title=\"title_example\", ), relationships=UserRelationships( roles=RelationshipToRoles( data=[ RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ], ), ), type=UsersType(\"users\"), ), ) # UserCreateRequest | # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e) Parameters Name Type Description Notes body UserCreateRequest Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] disable_user disable_user(user_id) Disable a user Disable a user. Can only be used with an application key belonging to an administrator user. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Disable a user api_instance.disable_user(user_id) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_invitation UserInvitationResponse get_invitation(user_invitation_uuid) Get a user invitation Returns a single user invitation by its UUID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_invitation_uuid = \"user_invitation_uuid_example\" # str | The UUID of the user invitation. # example passing only required values which don't have defaults set try: # Get a user invitation api_response = api_instance.get_invitation(user_invitation_uuid) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_invitation: %s\\n\" % e) Parameters Name Type Description Notes user_invitation_uuid str The UUID of the user invitation. Return type UserInvitationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_user UserResponse get_user(user_id) Get user details Get a user in the organization specified by the user\u2019s user_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_user_organizations UserResponse list_user_organizations(user_id) Get a user organization Get a user organization. Returns the user information and all organizations joined by this user. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user organization api_response = api_instance.list_user_organizations(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_organizations: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_user_permissions PermissionsResponse list_user_permissions(user_id) Get a user permissions Get a user permission set. Returns a list of the user\u2019s permissions granted by the associated user's roles. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user permissions api_response = api_instance.list_user_permissions(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_permissions: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_users UsersResponse list_users() List all users Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" sort_dir = QuerySortOrder(\"desc\") # QuerySortOrder | Direction of sort. Options: `asc`, `desc`. (optional) filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) filter_status = \"filter[status]_example\" # str | Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all users api_response = api_instance.list_users(page_size=page_size, page_number=page_number, sort=sort, sort_dir=sort_dir, filter=filter, filter_status=filter_status) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" sort_dir QuerySortOrder Direction of sort. Options: `asc`, `desc`. [optional] filter str Filter all users by the given string. Defaults to no filtering. [optional] filter_status str Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. [optional] Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] send_invitations UserInvitationsResponse send_invitations(body) Send invitation emails Sends emails to one or more users inviting them to join the organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserInvitationsRequest( data=[ UserInvitationData( relationships=UserInvitationRelationships( user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=UserInvitationsType(\"user_invitations\"), ), ], ) # UserInvitationsRequest | # example passing only required values which don't have defaults set try: # Send invitation emails api_response = api_instance.send_invitations(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->send_invitations: %s\\n\" % e) Parameters Name Type Description Notes body UserInvitationsRequest Return type UserInvitationsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_user UserResponse update_user(user_id, body) Update a user Edit a user. Can only be used with an application key belonging to an administrator user. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. body = UserUpdateRequest( data=UserUpdateData( attributes=UserUpdateAttributes( disabled=True, email=\"email_example\", name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # UserUpdateRequest | # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. body UserUpdateRequest Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.UsersApi"},{"location":"v2/UsersApi/#datadog_api_clientv2usersapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v2/users Create a user disable_user DELETE /api/v2/users/{user_id} Disable a user get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation get_user GET /api/v2/users/{user_id} Get user details list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions list_users GET /api/v2/users List all users send_invitations POST /api/v2/user_invitations Send invitation emails update_user PATCH /api/v2/users/{user_id} Update a user","title":"datadog_api_client.v2.UsersApi"},{"location":"v2/UsersApi/#create_user","text":"UserResponse create_user(body) Create a user Create a user for your organization.","title":"create_user"},{"location":"v2/UsersApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserCreateRequest( data=UserCreateData( attributes=UserCreateAttributes( email=\"jane.doe@example.com\", name=\"name_example\", title=\"title_example\", ), relationships=UserRelationships( roles=RelationshipToRoles( data=[ RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ], ), ), type=UsersType(\"users\"), ), ) # UserCreateRequest | # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters","text":"Name Type Description Notes body UserCreateRequest","title":"Parameters"},{"location":"v2/UsersApi/#return-type","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details","text":"Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#disable_user","text":"disable_user(user_id) Disable a user Disable a user. Can only be used with an application key belonging to an administrator user.","title":"disable_user"},{"location":"v2/UsersApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Disable a user api_instance.disable_user(user_id) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_1","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/UsersApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#get_invitation","text":"UserInvitationResponse get_invitation(user_invitation_uuid) Get a user invitation Returns a single user invitation by its UUID.","title":"get_invitation"},{"location":"v2/UsersApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_invitation_uuid = \"user_invitation_uuid_example\" # str | The UUID of the user invitation. # example passing only required values which don't have defaults set try: # Get a user invitation api_response = api_instance.get_invitation(user_invitation_uuid) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_invitation: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_2","text":"Name Type Description Notes user_invitation_uuid str The UUID of the user invitation.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_2","text":"UserInvitationResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#get_user","text":"UserResponse get_user(user_id) Get user details Get a user in the organization specified by the user\u2019s user_id .","title":"get_user"},{"location":"v2/UsersApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_3","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_3","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_3","text":"Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#list_user_organizations","text":"UserResponse list_user_organizations(user_id) Get a user organization Get a user organization. Returns the user information and all organizations joined by this user.","title":"list_user_organizations"},{"location":"v2/UsersApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user organization api_response = api_instance.list_user_organizations(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_organizations: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_4","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_4","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#list_user_permissions","text":"PermissionsResponse list_user_permissions(user_id) Get a user permissions Get a user permission set. Returns a list of the user\u2019s permissions granted by the associated user's roles.","title":"list_user_permissions"},{"location":"v2/UsersApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user permissions api_response = api_instance.list_user_permissions(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_permissions: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_5","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_5","text":"PermissionsResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#list_users","text":"UsersResponse list_users() List all users Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.","title":"list_users"},{"location":"v2/UsersApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" sort_dir = QuerySortOrder(\"desc\") # QuerySortOrder | Direction of sort. Options: `asc`, `desc`. (optional) filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) filter_status = \"filter[status]_example\" # str | Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all users api_response = api_instance.list_users(page_size=page_size, page_number=page_number, sort=sort, sort_dir=sort_dir, filter=filter, filter_status=filter_status) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_6","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" sort_dir QuerySortOrder Direction of sort. Options: `asc`, `desc`. [optional] filter str Filter all users by the given string. Defaults to no filtering. [optional] filter_status str Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. [optional]","title":"Parameters"},{"location":"v2/UsersApi/#return-type_6","text":"UsersResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#send_invitations","text":"UserInvitationsResponse send_invitations(body) Send invitation emails Sends emails to one or more users inviting them to join the organization.","title":"send_invitations"},{"location":"v2/UsersApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserInvitationsRequest( data=[ UserInvitationData( relationships=UserInvitationRelationships( user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=UserInvitationsType(\"user_invitations\"), ), ], ) # UserInvitationsRequest | # example passing only required values which don't have defaults set try: # Send invitation emails api_response = api_instance.send_invitations(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->send_invitations: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_7","text":"Name Type Description Notes body UserInvitationsRequest","title":"Parameters"},{"location":"v2/UsersApi/#return-type_7","text":"UserInvitationsResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_7","text":"Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#update_user","text":"UserResponse update_user(user_id, body) Update a user Edit a user. Can only be used with an application key belonging to an administrator user.","title":"update_user"},{"location":"v2/UsersApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. body = UserUpdateRequest( data=UserUpdateData( attributes=UserUpdateAttributes( disabled=True, email=\"email_example\", name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # UserUpdateRequest | # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_8","text":"Name Type Description Notes user_id str The ID of the user. body UserUpdateRequest","title":"Parameters"},{"location":"v2/UsersApi/#return-type_8","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersResponse/","text":"UsersResponse Response containing information about multiple users. Properties Name Type Description Notes data [User] Array of returned users. [optional] included [UserResponseIncludedItem] Array of objects related to the users. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsersResponse"},{"location":"v2/UsersResponse/#usersresponse","text":"Response containing information about multiple users.","title":"UsersResponse"},{"location":"v2/UsersResponse/#properties","text":"Name Type Description Notes data [User] Array of returned users. [optional] included [UserResponseIncludedItem] Array of objects related to the users. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UsersType/","text":"UsersType Users resource type. Properties Name Type Description Notes value str Users resource type. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsersType"},{"location":"v2/UsersType/#userstype","text":"Users resource type.","title":"UsersType"},{"location":"v2/UsersType/#properties","text":"Name Type Description Notes value str Users resource type. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"}]} \ No newline at end of file +{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"datadog-api-client-python This repository contains a Python API client for the Datadog API . The code is generated using openapi-generator and apigentools . Requirements Building and using the API client library requires Python 3.6+ . Installation To install the API client library, simply execute: pip install datadog-api-client Getting Started Please follow the installation instruction and execute the following Python code: import os from dateutil.parser import parse as dateutil_parser import datadog_api_client.v1 from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # Defining the host is optional and defaults to https://api.datadoghq.com # See configuration.py for a list of all supported configuration parameters. configuration = datadog_api_client.v1.Configuration( host = \"https://api.datadoghq.com\" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: apiKeyAuth configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY') # Configure API key authorization: appKeyAuth configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY') # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e) Unstable Endpoints This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints: configuration.unstable_operations[\"\"] = True where is the name of the method used to interact with that endpoint. For example: list_log_indexes , or get_logs_index Documentation for API Endpoints and Models Documentation for API endpoints and models can be found under the docs subdirectories, in v1 and v2 . It's also available on readthedocs . Documentation for Authorization Authenticate with the API by providing your API and Application keys in the configuration: configuration.api_key[\"apiKeyAuth\"] = \"YOUR_API_KEY\" configuration.api_key[\"appKeyAuth\"] = \"YOUR_APPLICATION_KEY\" Author support@datadoghq.com","title":"datadog-api-client-python"},{"location":"#datadog-api-client-python","text":"This repository contains a Python API client for the Datadog API . The code is generated using openapi-generator and apigentools .","title":"datadog-api-client-python"},{"location":"#requirements","text":"Building and using the API client library requires Python 3.6+ .","title":"Requirements"},{"location":"#installation","text":"To install the API client library, simply execute: pip install datadog-api-client","title":"Installation"},{"location":"#getting-started","text":"Please follow the installation instruction and execute the following Python code: import os from dateutil.parser import parse as dateutil_parser import datadog_api_client.v1 from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # Defining the host is optional and defaults to https://api.datadoghq.com # See configuration.py for a list of all supported configuration parameters. configuration = datadog_api_client.v1.Configuration( host = \"https://api.datadoghq.com\" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: apiKeyAuth configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY') # Configure API key authorization: appKeyAuth configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY') # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e)","title":"Getting Started"},{"location":"#unstable-endpoints","text":"This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints: configuration.unstable_operations[\"\"] = True where is the name of the method used to interact with that endpoint. For example: list_log_indexes , or get_logs_index","title":"Unstable Endpoints"},{"location":"#documentation-for-api-endpoints-and-models","text":"Documentation for API endpoints and models can be found under the docs subdirectories, in v1 and v2 . It's also available on readthedocs .","title":"Documentation for API Endpoints and Models"},{"location":"#documentation-for-authorization","text":"Authenticate with the API by providing your API and Application keys in the configuration: configuration.api_key[\"apiKeyAuth\"] = \"YOUR_API_KEY\" configuration.api_key[\"appKeyAuth\"] = \"YOUR_APPLICATION_KEY\"","title":"Documentation for Authorization"},{"location":"#author","text":"support@datadoghq.com","title":"Author"},{"location":"v1/","text":"datadog-api-client.v1 Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/ Requirements. Python >= 3.6 Installation & Usage pip install If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v1 Setuptools Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v1 Getting Started Please follow the installation procedure and then run the following: import time import datadog_api_client.v1 from pprint import pprint from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.model.api_error_response import APIErrorResponse from datadog_api_client.v1.model.aws_account import AWSAccount from datadog_api_client.v1.model.aws_account_create_response import AWSAccountCreateResponse from datadog_api_client.v1.model.aws_account_list_response import AWSAccountListResponse from datadog_api_client.v1.model.aws_tag_filter_create_request import AWSTagFilterCreateRequest from datadog_api_client.v1.model.aws_tag_filter_delete_request import AWSTagFilterDeleteRequest from datadog_api_client.v1.model.aws_tag_filter_list_response import AWSTagFilterListResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e) Documentation for API Endpoints All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description AWSIntegrationApi create_aws_account POST /api/v1/integration/aws Create an AWS integration AWSIntegrationApi create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter AWSIntegrationApi create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID AWSIntegrationApi delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration AWSIntegrationApi delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry AWSIntegrationApi list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules AWSIntegrationApi list_aws_accounts GET /api/v1/integration/aws List all AWS integrations AWSIntegrationApi list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters AWSIntegrationApi update_aws_account PUT /api/v1/integration/aws Update an AWS integration AWSLogsIntegrationApi check_aws_logs_lambda_async POST /api/v1/integration/aws/logs/check_async Check that an AWS Lambda Function exists AWSLogsIntegrationApi check_aws_logs_services_async POST /api/v1/integration/aws/logs/services_async Check permissions for log services AWSLogsIntegrationApi create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN AWSLogsIntegrationApi delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration AWSLogsIntegrationApi enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration AWSLogsIntegrationApi list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations AWSLogsIntegrationApi list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services AuthenticationApi validate GET /api/v1/validate Validate API key AzureIntegrationApi create_azure_integration POST /api/v1/integration/azure Create an Azure integration AzureIntegrationApi delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration AzureIntegrationApi list_azure_integration GET /api/v1/integration/azure List all Azure integrations AzureIntegrationApi update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters AzureIntegrationApi update_azure_integration PUT /api/v1/integration/azure Update an Azure integration DashboardListsApi create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list DashboardListsApi delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list DashboardListsApi get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list DashboardListsApi list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists DashboardListsApi update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list DashboardsApi create_dashboard POST /api/v1/dashboard Create a new dashboard DashboardsApi delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard DashboardsApi get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard DashboardsApi list_dashboards GET /api/v1/dashboard Get all dashboards DashboardsApi update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard DowntimesApi cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime DowntimesApi cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope DowntimesApi create_downtime POST /api/v1/downtime Schedule a downtime DowntimesApi get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime DowntimesApi list_downtimes GET /api/v1/downtime Get all downtimes DowntimesApi list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor DowntimesApi update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime EventsApi create_event POST /api/v1/events Post an event EventsApi get_event GET /api/v1/events/{event_id} Get an event EventsApi list_events GET /api/v1/events Query the event stream GCPIntegrationApi create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration GCPIntegrationApi delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration GCPIntegrationApi list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations GCPIntegrationApi update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration HostsApi get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts HostsApi list_hosts GET /api/v1/hosts Get all hosts for your organization HostsApi mute_host POST /api/v1/host/{host_name}/mute Mute a host HostsApi unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host IPRangesApi get_ip_ranges GET / List IP Ranges KeyManagementApi create_api_key POST /api/v1/api_key Create an API key KeyManagementApi create_application_key POST /api/v1/application_key Create an application key KeyManagementApi delete_api_key DELETE /api/v1/api_key/{key} Delete an API key KeyManagementApi delete_application_key DELETE /api/v1/application_key/{key} Delete an application key KeyManagementApi get_api_key GET /api/v1/api_key/{key} Get API key KeyManagementApi get_application_key GET /api/v1/application_key/{key} Get an application key KeyManagementApi list_api_keys GET /api/v1/api_key Get all API keys KeyManagementApi list_application_keys GET /api/v1/application_key Get all application keys KeyManagementApi update_api_key PUT /api/v1/api_key/{key} Edit an API key KeyManagementApi update_application_key PUT /api/v1/application_key/{key} Edit an application key LogsApi list_logs POST /api/v1/logs-queries/list Search logs LogsApi submit_log POST /v1/input Send logs LogsIndexesApi create_logs_index POST /api/v1/logs/config/indexes Create an index LogsIndexesApi get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index LogsIndexesApi get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order LogsIndexesApi list_log_indexes GET /api/v1/logs/config/indexes Get all indexes LogsIndexesApi update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index LogsIndexesApi update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order LogsPipelinesApi create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline LogsPipelinesApi delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline LogsPipelinesApi get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline LogsPipelinesApi get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order LogsPipelinesApi list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines LogsPipelinesApi update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline LogsPipelinesApi update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order MetricsApi get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata MetricsApi list_active_metrics GET /api/v1/metrics Get active metrics list MetricsApi list_metrics GET /api/v1/search Search metrics MetricsApi query_metrics GET /api/v1/query Query timeseries points MetricsApi submit_metrics POST /api/v1/series Submit metrics MetricsApi update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata MonitorsApi check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted MonitorsApi create_monitor POST /api/v1/monitor Create a monitor MonitorsApi delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor MonitorsApi get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details MonitorsApi list_monitors GET /api/v1/monitor Get all monitor details MonitorsApi update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor MonitorsApi validate_monitor POST /api/v1/monitor/validate Validate a monitor OrganizationsApi create_child_org POST /api/v1/org Create a child organization OrganizationsApi get_org GET /api/v1/org/{public_id} Get organization information OrganizationsApi list_orgs GET /api/v1/org List your managed organizations OrganizationsApi update_org PUT /api/v1/org/{public_id} Update your organization OrganizationsApi upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata PagerDutyIntegrationApi create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object PagerDutyIntegrationApi delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object PagerDutyIntegrationApi get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object PagerDutyIntegrationApi update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object ServiceChecksApi submit_service_check POST /api/v1/check_run Submit a Service Check ServiceLevelObjectiveCorrectionsApi create_slo_correction POST /api/v1/slo/correction Create an SLO correction ServiceLevelObjectiveCorrectionsApi delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction ServiceLevelObjectiveCorrectionsApi get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO ServiceLevelObjectiveCorrectionsApi list_slo_correction GET /api/v1/slo/correction Get all SLO corrections ServiceLevelObjectiveCorrectionsApi update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction ServiceLevelObjectivesApi check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted ServiceLevelObjectivesApi create_slo POST /api/v1/slo Create an SLO object ServiceLevelObjectivesApi delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO ServiceLevelObjectivesApi delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes ServiceLevelObjectivesApi get_slo GET /api/v1/slo/{slo_id} Get an SLO's details ServiceLevelObjectivesApi get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history ServiceLevelObjectivesApi list_slos GET /api/v1/slo Get all SLOs ServiceLevelObjectivesApi update_slo PUT /api/v1/slo/{slo_id} Update an SLO SlackIntegrationApi create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel SlackIntegrationApi get_slack_integration_channel GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Get a Slack integration channel SlackIntegrationApi get_slack_integration_channels GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration SlackIntegrationApi remove_slack_integration_channel DELETE /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Remove a Slack integration channel SlackIntegrationApi update_slack_integration_channel PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel SnapshotsApi get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots SyntheticsApi create_global_variable POST /api/v1/synthetics/variables Create a global variable SyntheticsApi create_private_location POST /api/v1/synthetics/private-locations Create a private location SyntheticsApi create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test SyntheticsApi create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test SyntheticsApi delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable SyntheticsApi delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location SyntheticsApi delete_tests POST /api/v1/synthetics/tests/delete Delete tests SyntheticsApi edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable SyntheticsApi get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test SyntheticsApi get_api_test_latest_results GET /api/v1/synthetics/tests/{public_id}/results Get an API test's latest results summaries SyntheticsApi get_api_test_result GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result SyntheticsApi get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test SyntheticsApi get_browser_test_latest_results GET /api/v1/synthetics/tests/browser/{public_id}/results Get a browser test's latest results summaries SyntheticsApi get_browser_test_result GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result SyntheticsApi get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable SyntheticsApi get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location SyntheticsApi get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration SyntheticsApi list_locations GET /api/v1/synthetics/locations Get all locations (public and private) SyntheticsApi list_tests GET /api/v1/synthetics/tests Get the list of all tests SyntheticsApi trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines SyntheticsApi update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test SyntheticsApi update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test SyntheticsApi update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location SyntheticsApi update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test TagsApi create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host TagsApi delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags TagsApi get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags TagsApi list_host_tags GET /api/v1/tags/hosts Get Tags TagsApi update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags UsageMeteringApi get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports UsageMeteringApi get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management UsageMeteringApi get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans UsageMeteringApi get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports UsageMeteringApi get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports UsageMeteringApi get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports UsageMeteringApi get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits UsageMeteringApi get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs UsageMeteringApi get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution UsageMeteringApi get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account UsageMeteringApi get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring UsageMeteringApi get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate UsageMeteringApi get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers UsageMeteringApi get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans UsageMeteringApi get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT UsageMeteringApi get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda UsageMeteringApi get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs UsageMeteringApi get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index UsageMeteringApi get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention UsageMeteringApi get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows UsageMeteringApi get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts UsageMeteringApi get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts UsageMeteringApi get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions UsageMeteringApi get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices UsageMeteringApi get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account UsageMeteringApi get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks UsageMeteringApi get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks UsageMeteringApi get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks UsageMeteringApi get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics UsageMeteringApi get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average UsageMeteringApi get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search UsersApi create_user POST /api/v1/user Create a user UsersApi disable_user DELETE /api/v1/user/{user_handle} Disable a user UsersApi get_user GET /api/v1/user/{user_handle} Get user details UsersApi list_users GET /api/v1/user List all users UsersApi update_user PUT /api/v1/user/{user_handle} Update a user Documentation For Models APIErrorResponse AWSAccount AWSAccountAndLambdaRequest AWSAccountCreateResponse AWSAccountListResponse AWSLogsAsyncError AWSLogsAsyncResponse AWSLogsLambda AWSLogsListResponse AWSLogsListServicesResponse AWSLogsServicesRequest AWSNamespace AWSTagFilter AWSTagFilterCreateRequest AWSTagFilterDeleteRequest AWSTagFilterListResponse AccessRole AlertGraphWidgetDefinition AlertGraphWidgetDefinitionType AlertValueWidgetDefinition AlertValueWidgetDefinitionType ApiKey ApiKeyListResponse ApiKeyResponse ApmStatsQueryColumnType ApmStatsQueryDefinition ApmStatsQueryRowType ApplicationKey ApplicationKeyListResponse ApplicationKeyResponse AuthenticationValidationResponse AzureAccount AzureAccountListResponse CancelDowntimesByScopeRequest CanceledDowntimesIds ChangeWidgetDefinition ChangeWidgetDefinitionType ChangeWidgetRequest CheckCanDeleteMonitorResponse CheckCanDeleteMonitorResponseData CheckCanDeleteSLOResponse CheckCanDeleteSLOResponseData CheckStatusWidgetDefinition CheckStatusWidgetDefinitionType ContentEncoding Creator Dashboard DashboardDeleteResponse DashboardLayoutType DashboardList DashboardListDeleteResponse DashboardListListResponse DashboardReflowType DashboardSummary DashboardSummaryDefinition DashboardTemplateVariable DashboardTemplateVariablePreset DashboardTemplateVariablePresetValue DeletedMonitor DistributionWidgetDefinition DistributionWidgetDefinitionType DistributionWidgetRequest DistributionWidgetXAxis DistributionWidgetYAxis Downtime DowntimeRecurrence Event EventAlertType EventCreateRequest EventCreateResponse EventListResponse EventPriority EventQueryDefinition EventResponse EventStreamWidgetDefinition EventStreamWidgetDefinitionType EventTimelineWidgetDefinition EventTimelineWidgetDefinitionType FormulaAndFunctionEventAggregation FormulaAndFunctionEventQueryDefinition FormulaAndFunctionEventQueryDefinitionCompute FormulaAndFunctionEventQueryDefinitionSearch FormulaAndFunctionEventQueryGroupBy FormulaAndFunctionEventQueryGroupBySort FormulaAndFunctionEventsDataSource FormulaAndFunctionMetricAggregation FormulaAndFunctionMetricDataSource FormulaAndFunctionMetricQueryDefinition FormulaAndFunctionProcessQueryDataSource FormulaAndFunctionProcessQueryDefinition FormulaAndFunctionQueryDefinition FormulaAndFunctionResponseFormat FreeTextWidgetDefinition FreeTextWidgetDefinitionType GCPAccount GCPAccountListResponse GeomapWidgetDefinition GeomapWidgetDefinitionStyle GeomapWidgetDefinitionType GeomapWidgetDefinitionView GeomapWidgetRequest GraphSnapshot GroupWidgetDefinition GroupWidgetDefinitionType HTTPLog HTTPLogError HTTPLogItem HTTPMethod HeatMapWidgetDefinition HeatMapWidgetDefinitionType HeatMapWidgetRequest Host HostListResponse HostMapRequest HostMapWidgetDefinition HostMapWidgetDefinitionRequests HostMapWidgetDefinitionStyle HostMapWidgetDefinitionType HostMeta HostMetrics HostMuteResponse HostMuteSettings HostTags HostTotals IFrameWidgetDefinition IFrameWidgetDefinitionType IPPrefixesAPI IPPrefixesAPM IPPrefixesAgents IPPrefixesLogs IPPrefixesProcess IPPrefixesSynthetics IPPrefixesWebhooks IPRanges IdpFormData IdpResponse ImageWidgetDefinition ImageWidgetDefinitionType IntakePayloadAccepted Log LogContent LogQueryDefinition LogQueryDefinitionGroupBy LogQueryDefinitionGroupBySort LogQueryDefinitionSearch LogStreamWidgetDefinition LogStreamWidgetDefinitionType LogsAPIError LogsAPIErrorResponse LogsArithmeticProcessor LogsArithmeticProcessorType LogsAttributeRemapper LogsAttributeRemapperType LogsByRetention LogsByRetentionMonthlyUsage LogsByRetentionOrgUsage LogsByRetentionOrgs LogsCategoryProcessor LogsCategoryProcessorCategory LogsCategoryProcessorType LogsDateRemapper LogsDateRemapperType LogsExclusion LogsExclusionFilter LogsFilter LogsGeoIPParser LogsGeoIPParserType LogsGrokParser LogsGrokParserRules LogsGrokParserType LogsIndex LogsIndexListResponse LogsIndexUpdateRequest LogsIndexesOrder LogsListRequest LogsListRequestTime LogsListResponse LogsLookupProcessor LogsLookupProcessorType LogsMessageRemapper LogsMessageRemapperType LogsPipeline LogsPipelineList LogsPipelineProcessor LogsPipelineProcessorType LogsPipelinesOrder LogsProcessor LogsQueryCompute LogsRetentionAggSumUsage LogsRetentionSumUsage LogsServiceRemapper LogsServiceRemapperType LogsSort LogsStatusRemapper LogsStatusRemapperType LogsStringBuilderProcessor LogsStringBuilderProcessorType LogsTraceRemapper LogsTraceRemapperType LogsURLParser LogsURLParserType LogsUserAgentParser LogsUserAgentParserType MetricMetadata MetricSearchResponse MetricSearchResponseResults MetricsListResponse MetricsPayload MetricsQueryMetadata MetricsQueryResponse MetricsQueryUnit Monitor MonitorDeviceID MonitorOptions MonitorOptionsAggregation MonitorOverallStates MonitorState MonitorStateGroup MonitorSummaryWidgetDefinition MonitorSummaryWidgetDefinitionType MonitorThresholdWindowOptions MonitorThresholds MonitorType MonitorUpdateRequest NoteWidgetDefinition NoteWidgetDefinitionType Organization OrganizationBilling OrganizationCreateBody OrganizationCreateResponse OrganizationListResponse OrganizationResponse OrganizationSettings OrganizationSettingsSaml OrganizationSettingsSamlAutocreateUsersDomains OrganizationSettingsSamlIdpInitiatedLogin OrganizationSettingsSamlStrictMode OrganizationSubscription PagerDutyService PagerDutyServiceKey PagerDutyServiceName Point ProcessQueryDefinition QuerySortOrder QueryValueWidgetDefinition QueryValueWidgetDefinitionType QueryValueWidgetRequest SLOBulkDelete SLOBulkDeleteError SLOBulkDeleteResponse SLOBulkDeleteResponseData SLOCorrection SLOCorrectionCategory SLOCorrectionCreateData SLOCorrectionCreateRequest SLOCorrectionCreateRequestAttributes SLOCorrectionListResponse SLOCorrectionResponse SLOCorrectionResponseAttributes SLOCorrectionType SLOCorrectionUpdateData SLOCorrectionUpdateRequest SLOCorrectionUpdateRequestAttributes SLODeleteResponse SLOErrorBudgetRemainingData SLOErrorTimeframe SLOHistoryMetrics SLOHistoryMetricsSeries SLOHistoryMetricsSeriesMetadata SLOHistoryMetricsSeriesMetadataUnit SLOHistoryResponse SLOHistoryResponseData SLOHistoryResponseError SLOHistorySLIData SLOListResponse SLOListResponseMetadata SLOListResponseMetadataPage SLOResponse SLOResponseData SLOThreshold SLOTimeframe SLOType SLOTypeNumeric SLOWidgetDefinition SLOWidgetDefinitionType ScatterPlotRequest ScatterPlotWidgetDefinition ScatterPlotWidgetDefinitionRequests ScatterPlotWidgetDefinitionType Series ServiceCheck ServiceCheckStatus ServiceChecks ServiceLevelObjective ServiceLevelObjectiveQuery ServiceLevelObjectiveRequest ServiceMapWidgetDefinition ServiceMapWidgetDefinitionType ServiceSummaryWidgetDefinition ServiceSummaryWidgetDefinitionType SlackIntegrationChannel SlackIntegrationChannelDisplay SlackIntegrationChannels SyntheticsAPIStep SyntheticsAPIStepSubtype SyntheticsAPITest SyntheticsAPITestConfig SyntheticsAPITestResultData SyntheticsAPITestResultFull SyntheticsAPITestResultFullCheck SyntheticsAPITestResultShort SyntheticsAPITestResultShortResult SyntheticsAPITestType SyntheticsAssertion SyntheticsAssertionJSONPathOperator SyntheticsAssertionJSONPathTarget SyntheticsAssertionJSONPathTargetTarget SyntheticsAssertionOperator SyntheticsAssertionTarget SyntheticsAssertionType SyntheticsBasicAuth SyntheticsBrowserError SyntheticsBrowserErrorType SyntheticsBrowserTest SyntheticsBrowserTestConfig SyntheticsBrowserTestResultData SyntheticsBrowserTestResultFull SyntheticsBrowserTestResultFullCheck SyntheticsBrowserTestResultShort SyntheticsBrowserTestResultShortResult SyntheticsBrowserTestType SyntheticsBrowserVariable SyntheticsBrowserVariableType SyntheticsCITest SyntheticsCITestBody SyntheticsCITestMetadata SyntheticsCITestMetadataCi SyntheticsCITestMetadataGit SyntheticsCheckType SyntheticsConfigVariable SyntheticsConfigVariableType SyntheticsCoreWebVitals SyntheticsDeleteTestsPayload SyntheticsDeleteTestsResponse SyntheticsDeletedTest SyntheticsDevice SyntheticsDeviceID SyntheticsErrorCode SyntheticsGetAPITestLatestResultsResponse SyntheticsGetBrowserTestLatestResultsResponse SyntheticsGlobalVariable SyntheticsGlobalVariableParseTestOptions SyntheticsGlobalVariableParseTestOptionsType SyntheticsGlobalVariableParserType SyntheticsGlobalVariableValue SyntheticsListTestsResponse SyntheticsLocation SyntheticsLocations SyntheticsParsingOptions SyntheticsPlayingTab SyntheticsPrivateLocation SyntheticsPrivateLocationCreationResponse SyntheticsPrivateLocationCreationResponseResultEncryption SyntheticsPrivateLocationSecrets SyntheticsPrivateLocationSecretsAuthentication SyntheticsPrivateLocationSecretsConfigDecryption SyntheticsSSLCertificate SyntheticsSSLCertificateIssuer SyntheticsSSLCertificateSubject SyntheticsStep SyntheticsStepDetail SyntheticsStepDetailWarning SyntheticsStepType SyntheticsTestConfig SyntheticsTestDetails SyntheticsTestDetailsSubType SyntheticsTestDetailsType SyntheticsTestHeaders SyntheticsTestMonitorStatus SyntheticsTestOptions SyntheticsTestOptionsMonitorOptions SyntheticsTestOptionsRetry SyntheticsTestPauseStatus SyntheticsTestProcessStatus SyntheticsTestRequest SyntheticsTestRequestCertificate SyntheticsTestRequestCertificateItem SyntheticsTickInterval SyntheticsTiming SyntheticsTriggerCITestLocation SyntheticsTriggerCITestRunResult SyntheticsTriggerCITestsResponse SyntheticsUpdateTestPauseStatusPayload SyntheticsVariableParser SyntheticsWarningType TableWidgetCellDisplayMode TableWidgetDefinition TableWidgetDefinitionType TableWidgetHasSearchBar TableWidgetRequest TagToHosts TargetFormatType TimeseriesWidgetDefinition TimeseriesWidgetDefinitionType TimeseriesWidgetExpressionAlias TimeseriesWidgetLegendColumn TimeseriesWidgetLegendLayout TimeseriesWidgetRequest ToplistWidgetDefinition ToplistWidgetDefinitionType ToplistWidgetRequest UsageAnalyzedLogsHour UsageAnalyzedLogsResponse UsageAttributionAggregates UsageAttributionAggregatesBody UsageAttributionBody UsageAttributionMetadata UsageAttributionPagination UsageAttributionResponse UsageAttributionSort UsageAttributionTagNames UsageAttributionValues UsageBillableSummaryBody UsageBillableSummaryHour UsageBillableSummaryKeys UsageBillableSummaryResponse UsageComplianceHour UsageComplianceResponse UsageCustomReportsAttributes UsageCustomReportsData UsageCustomReportsMeta UsageCustomReportsPage UsageCustomReportsResponse UsageFargateHour UsageFargateResponse UsageHostHour UsageHostsResponse UsageIncidentManagementHour UsageIncidentManagementResponse UsageIndexedSpansHour UsageIndexedSpansResponse UsageIngestedSpansHour UsageIngestedSpansResponse UsageIoTHour UsageIoTResponse UsageLambdaHour UsageLambdaResponse UsageLogsByIndexHour UsageLogsByIndexResponse UsageLogsByRetentionHour UsageLogsByRetentionResponse UsageLogsHour UsageLogsResponse UsageMetricCategory UsageNetworkFlowsHour UsageNetworkFlowsResponse UsageNetworkHostsHour UsageNetworkHostsResponse UsageProfilingHour UsageProfilingResponse UsageReportsType UsageRumSessionsHour UsageRumSessionsResponse UsageSNMPHour UsageSNMPResponse UsageSort UsageSortDirection UsageSpecifiedCustomReportsAttributes UsageSpecifiedCustomReportsData UsageSpecifiedCustomReportsMeta UsageSpecifiedCustomReportsPage UsageSpecifiedCustomReportsResponse UsageSummaryDate UsageSummaryDateOrg UsageSummaryResponse UsageSyntheticsAPIHour UsageSyntheticsAPIResponse UsageSyntheticsBrowserHour UsageSyntheticsBrowserResponse UsageSyntheticsHour UsageSyntheticsResponse UsageTimeseriesHour UsageTimeseriesResponse UsageTopAvgMetricsHour UsageTopAvgMetricsMetadata UsageTopAvgMetricsResponse UsageTraceHour UsageTraceResponse UsageTracingWithoutLimitsHour UsageTracingWithoutLimitsResponse User UserDisableResponse UserListResponse UserResponse Widget WidgetAggregator WidgetAxis WidgetChangeType WidgetColorPreference WidgetComparator WidgetCompareTo WidgetConditionalFormat WidgetCustomLink WidgetDefinition WidgetDisplayType WidgetEvent WidgetEventSize WidgetFieldSort WidgetFormula WidgetFormulaLimit WidgetGrouping WidgetHorizontalAlign WidgetImageSizing WidgetLayout WidgetLayoutType WidgetLineType WidgetLineWidth WidgetLiveSpan WidgetMargin WidgetMarker WidgetMessageDisplay WidgetMonitorSummaryDisplayFormat WidgetMonitorSummarySort WidgetNodeType WidgetOrderBy WidgetPalette WidgetRequestStyle WidgetServiceSummaryDisplayFormat WidgetSizeFormat WidgetSort WidgetStyle WidgetSummaryType WidgetTextAlign WidgetTickEdge WidgetTime WidgetTimeWindows WidgetVerticalAlign WidgetViewMode WidgetVizType Documentation For Authorization 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 Author support@datadoghq.com Notes for Large OpenAPI documents If the OpenAPI document is large, imports in datadog_api_client.v1.apis and datadog_api_client.v1.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v1.api.default_api import DefaultApi - from datadog_api_client.v1.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v1 from datadog_api_client.v1.apis import * from datadog_api_client.v1.models import *","title":"datadog-api-client.v1"},{"location":"v1/#datadog-api-clientv1","text":"Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/","title":"datadog-api-client.v1"},{"location":"v1/#requirements","text":"Python >= 3.6","title":"Requirements."},{"location":"v1/#installation-usage","text":"","title":"Installation & Usage"},{"location":"v1/#pip-install","text":"If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v1","title":"pip install"},{"location":"v1/#setuptools","text":"Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v1","title":"Setuptools"},{"location":"v1/#getting-started","text":"Please follow the installation procedure and then run the following: import time import datadog_api_client.v1 from pprint import pprint from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.model.api_error_response import APIErrorResponse from datadog_api_client.v1.model.aws_account import AWSAccount from datadog_api_client.v1.model.aws_account_create_response import AWSAccountCreateResponse from datadog_api_client.v1.model.aws_account_list_response import AWSAccountListResponse from datadog_api_client.v1.model.aws_tag_filter_create_request import AWSTagFilterCreateRequest from datadog_api_client.v1.model.aws_tag_filter_delete_request import AWSTagFilterDeleteRequest from datadog_api_client.v1.model.aws_tag_filter_list_response import AWSTagFilterListResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v1.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except datadog_api_client.v1.ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e)","title":"Getting Started"},{"location":"v1/#documentation-for-api-endpoints","text":"All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description AWSIntegrationApi create_aws_account POST /api/v1/integration/aws Create an AWS integration AWSIntegrationApi create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter AWSIntegrationApi create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID AWSIntegrationApi delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration AWSIntegrationApi delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry AWSIntegrationApi list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules AWSIntegrationApi list_aws_accounts GET /api/v1/integration/aws List all AWS integrations AWSIntegrationApi list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters AWSIntegrationApi update_aws_account PUT /api/v1/integration/aws Update an AWS integration AWSLogsIntegrationApi check_aws_logs_lambda_async POST /api/v1/integration/aws/logs/check_async Check that an AWS Lambda Function exists AWSLogsIntegrationApi check_aws_logs_services_async POST /api/v1/integration/aws/logs/services_async Check permissions for log services AWSLogsIntegrationApi create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN AWSLogsIntegrationApi delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration AWSLogsIntegrationApi enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration AWSLogsIntegrationApi list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations AWSLogsIntegrationApi list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services AuthenticationApi validate GET /api/v1/validate Validate API key AzureIntegrationApi create_azure_integration POST /api/v1/integration/azure Create an Azure integration AzureIntegrationApi delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration AzureIntegrationApi list_azure_integration GET /api/v1/integration/azure List all Azure integrations AzureIntegrationApi update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters AzureIntegrationApi update_azure_integration PUT /api/v1/integration/azure Update an Azure integration DashboardListsApi create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list DashboardListsApi delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list DashboardListsApi get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list DashboardListsApi list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists DashboardListsApi update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list DashboardsApi create_dashboard POST /api/v1/dashboard Create a new dashboard DashboardsApi delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard DashboardsApi get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard DashboardsApi list_dashboards GET /api/v1/dashboard Get all dashboards DashboardsApi update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard DowntimesApi cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime DowntimesApi cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope DowntimesApi create_downtime POST /api/v1/downtime Schedule a downtime DowntimesApi get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime DowntimesApi list_downtimes GET /api/v1/downtime Get all downtimes DowntimesApi list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor DowntimesApi update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime EventsApi create_event POST /api/v1/events Post an event EventsApi get_event GET /api/v1/events/{event_id} Get an event EventsApi list_events GET /api/v1/events Query the event stream GCPIntegrationApi create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration GCPIntegrationApi delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration GCPIntegrationApi list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations GCPIntegrationApi update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration HostsApi get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts HostsApi list_hosts GET /api/v1/hosts Get all hosts for your organization HostsApi mute_host POST /api/v1/host/{host_name}/mute Mute a host HostsApi unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host IPRangesApi get_ip_ranges GET / List IP Ranges KeyManagementApi create_api_key POST /api/v1/api_key Create an API key KeyManagementApi create_application_key POST /api/v1/application_key Create an application key KeyManagementApi delete_api_key DELETE /api/v1/api_key/{key} Delete an API key KeyManagementApi delete_application_key DELETE /api/v1/application_key/{key} Delete an application key KeyManagementApi get_api_key GET /api/v1/api_key/{key} Get API key KeyManagementApi get_application_key GET /api/v1/application_key/{key} Get an application key KeyManagementApi list_api_keys GET /api/v1/api_key Get all API keys KeyManagementApi list_application_keys GET /api/v1/application_key Get all application keys KeyManagementApi update_api_key PUT /api/v1/api_key/{key} Edit an API key KeyManagementApi update_application_key PUT /api/v1/application_key/{key} Edit an application key LogsApi list_logs POST /api/v1/logs-queries/list Search logs LogsApi submit_log POST /v1/input Send logs LogsIndexesApi create_logs_index POST /api/v1/logs/config/indexes Create an index LogsIndexesApi get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index LogsIndexesApi get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order LogsIndexesApi list_log_indexes GET /api/v1/logs/config/indexes Get all indexes LogsIndexesApi update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index LogsIndexesApi update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order LogsPipelinesApi create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline LogsPipelinesApi delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline LogsPipelinesApi get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline LogsPipelinesApi get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order LogsPipelinesApi list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines LogsPipelinesApi update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline LogsPipelinesApi update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order MetricsApi get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata MetricsApi list_active_metrics GET /api/v1/metrics Get active metrics list MetricsApi list_metrics GET /api/v1/search Search metrics MetricsApi query_metrics GET /api/v1/query Query timeseries points MetricsApi submit_metrics POST /api/v1/series Submit metrics MetricsApi update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata MonitorsApi check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted MonitorsApi create_monitor POST /api/v1/monitor Create a monitor MonitorsApi delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor MonitorsApi get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details MonitorsApi list_monitors GET /api/v1/monitor Get all monitor details MonitorsApi update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor MonitorsApi validate_monitor POST /api/v1/monitor/validate Validate a monitor OrganizationsApi create_child_org POST /api/v1/org Create a child organization OrganizationsApi get_org GET /api/v1/org/{public_id} Get organization information OrganizationsApi list_orgs GET /api/v1/org List your managed organizations OrganizationsApi update_org PUT /api/v1/org/{public_id} Update your organization OrganizationsApi upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata PagerDutyIntegrationApi create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object PagerDutyIntegrationApi delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object PagerDutyIntegrationApi get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object PagerDutyIntegrationApi update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object ServiceChecksApi submit_service_check POST /api/v1/check_run Submit a Service Check ServiceLevelObjectiveCorrectionsApi create_slo_correction POST /api/v1/slo/correction Create an SLO correction ServiceLevelObjectiveCorrectionsApi delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction ServiceLevelObjectiveCorrectionsApi get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO ServiceLevelObjectiveCorrectionsApi list_slo_correction GET /api/v1/slo/correction Get all SLO corrections ServiceLevelObjectiveCorrectionsApi update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction ServiceLevelObjectivesApi check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted ServiceLevelObjectivesApi create_slo POST /api/v1/slo Create an SLO object ServiceLevelObjectivesApi delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO ServiceLevelObjectivesApi delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes ServiceLevelObjectivesApi get_slo GET /api/v1/slo/{slo_id} Get an SLO's details ServiceLevelObjectivesApi get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history ServiceLevelObjectivesApi list_slos GET /api/v1/slo Get all SLOs ServiceLevelObjectivesApi update_slo PUT /api/v1/slo/{slo_id} Update an SLO SlackIntegrationApi create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel SlackIntegrationApi get_slack_integration_channel GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Get a Slack integration channel SlackIntegrationApi get_slack_integration_channels GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration SlackIntegrationApi remove_slack_integration_channel DELETE /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Remove a Slack integration channel SlackIntegrationApi update_slack_integration_channel PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel SnapshotsApi get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots SyntheticsApi create_global_variable POST /api/v1/synthetics/variables Create a global variable SyntheticsApi create_private_location POST /api/v1/synthetics/private-locations Create a private location SyntheticsApi create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test SyntheticsApi create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test SyntheticsApi delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable SyntheticsApi delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location SyntheticsApi delete_tests POST /api/v1/synthetics/tests/delete Delete tests SyntheticsApi edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable SyntheticsApi get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test SyntheticsApi get_api_test_latest_results GET /api/v1/synthetics/tests/{public_id}/results Get an API test's latest results summaries SyntheticsApi get_api_test_result GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result SyntheticsApi get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test SyntheticsApi get_browser_test_latest_results GET /api/v1/synthetics/tests/browser/{public_id}/results Get a browser test's latest results summaries SyntheticsApi get_browser_test_result GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result SyntheticsApi get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable SyntheticsApi get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location SyntheticsApi get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration SyntheticsApi list_locations GET /api/v1/synthetics/locations Get all locations (public and private) SyntheticsApi list_tests GET /api/v1/synthetics/tests Get the list of all tests SyntheticsApi trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines SyntheticsApi update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test SyntheticsApi update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test SyntheticsApi update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location SyntheticsApi update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test TagsApi create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host TagsApi delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags TagsApi get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags TagsApi list_host_tags GET /api/v1/tags/hosts Get Tags TagsApi update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags UsageMeteringApi get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports UsageMeteringApi get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management UsageMeteringApi get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans UsageMeteringApi get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports UsageMeteringApi get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports UsageMeteringApi get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports UsageMeteringApi get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits UsageMeteringApi get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs UsageMeteringApi get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution UsageMeteringApi get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account UsageMeteringApi get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring UsageMeteringApi get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate UsageMeteringApi get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers UsageMeteringApi get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans UsageMeteringApi get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT UsageMeteringApi get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda UsageMeteringApi get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs UsageMeteringApi get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index UsageMeteringApi get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention UsageMeteringApi get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows UsageMeteringApi get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts UsageMeteringApi get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts UsageMeteringApi get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions UsageMeteringApi get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices UsageMeteringApi get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account UsageMeteringApi get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks UsageMeteringApi get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks UsageMeteringApi get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks UsageMeteringApi get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics UsageMeteringApi get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average UsageMeteringApi get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search UsersApi create_user POST /api/v1/user Create a user UsersApi disable_user DELETE /api/v1/user/{user_handle} Disable a user UsersApi get_user GET /api/v1/user/{user_handle} Get user details UsersApi list_users GET /api/v1/user List all users UsersApi update_user PUT /api/v1/user/{user_handle} Update a user","title":"Documentation for API Endpoints"},{"location":"v1/#documentation-for-models","text":"APIErrorResponse AWSAccount AWSAccountAndLambdaRequest AWSAccountCreateResponse AWSAccountListResponse AWSLogsAsyncError AWSLogsAsyncResponse AWSLogsLambda AWSLogsListResponse AWSLogsListServicesResponse AWSLogsServicesRequest AWSNamespace AWSTagFilter AWSTagFilterCreateRequest AWSTagFilterDeleteRequest AWSTagFilterListResponse AccessRole AlertGraphWidgetDefinition AlertGraphWidgetDefinitionType AlertValueWidgetDefinition AlertValueWidgetDefinitionType ApiKey ApiKeyListResponse ApiKeyResponse ApmStatsQueryColumnType ApmStatsQueryDefinition ApmStatsQueryRowType ApplicationKey ApplicationKeyListResponse ApplicationKeyResponse AuthenticationValidationResponse AzureAccount AzureAccountListResponse CancelDowntimesByScopeRequest CanceledDowntimesIds ChangeWidgetDefinition ChangeWidgetDefinitionType ChangeWidgetRequest CheckCanDeleteMonitorResponse CheckCanDeleteMonitorResponseData CheckCanDeleteSLOResponse CheckCanDeleteSLOResponseData CheckStatusWidgetDefinition CheckStatusWidgetDefinitionType ContentEncoding Creator Dashboard DashboardDeleteResponse DashboardLayoutType DashboardList DashboardListDeleteResponse DashboardListListResponse DashboardReflowType DashboardSummary DashboardSummaryDefinition DashboardTemplateVariable DashboardTemplateVariablePreset DashboardTemplateVariablePresetValue DeletedMonitor DistributionWidgetDefinition DistributionWidgetDefinitionType DistributionWidgetRequest DistributionWidgetXAxis DistributionWidgetYAxis Downtime DowntimeRecurrence Event EventAlertType EventCreateRequest EventCreateResponse EventListResponse EventPriority EventQueryDefinition EventResponse EventStreamWidgetDefinition EventStreamWidgetDefinitionType EventTimelineWidgetDefinition EventTimelineWidgetDefinitionType FormulaAndFunctionEventAggregation FormulaAndFunctionEventQueryDefinition FormulaAndFunctionEventQueryDefinitionCompute FormulaAndFunctionEventQueryDefinitionSearch FormulaAndFunctionEventQueryGroupBy FormulaAndFunctionEventQueryGroupBySort FormulaAndFunctionEventsDataSource FormulaAndFunctionMetricAggregation FormulaAndFunctionMetricDataSource FormulaAndFunctionMetricQueryDefinition FormulaAndFunctionProcessQueryDataSource FormulaAndFunctionProcessQueryDefinition FormulaAndFunctionQueryDefinition FormulaAndFunctionResponseFormat FreeTextWidgetDefinition FreeTextWidgetDefinitionType GCPAccount GCPAccountListResponse GeomapWidgetDefinition GeomapWidgetDefinitionStyle GeomapWidgetDefinitionType GeomapWidgetDefinitionView GeomapWidgetRequest GraphSnapshot GroupWidgetDefinition GroupWidgetDefinitionType HTTPLog HTTPLogError HTTPLogItem HTTPMethod HeatMapWidgetDefinition HeatMapWidgetDefinitionType HeatMapWidgetRequest Host HostListResponse HostMapRequest HostMapWidgetDefinition HostMapWidgetDefinitionRequests HostMapWidgetDefinitionStyle HostMapWidgetDefinitionType HostMeta HostMetrics HostMuteResponse HostMuteSettings HostTags HostTotals IFrameWidgetDefinition IFrameWidgetDefinitionType IPPrefixesAPI IPPrefixesAPM IPPrefixesAgents IPPrefixesLogs IPPrefixesProcess IPPrefixesSynthetics IPPrefixesWebhooks IPRanges IdpFormData IdpResponse ImageWidgetDefinition ImageWidgetDefinitionType IntakePayloadAccepted Log LogContent LogQueryDefinition LogQueryDefinitionGroupBy LogQueryDefinitionGroupBySort LogQueryDefinitionSearch LogStreamWidgetDefinition LogStreamWidgetDefinitionType LogsAPIError LogsAPIErrorResponse LogsArithmeticProcessor LogsArithmeticProcessorType LogsAttributeRemapper LogsAttributeRemapperType LogsByRetention LogsByRetentionMonthlyUsage LogsByRetentionOrgUsage LogsByRetentionOrgs LogsCategoryProcessor LogsCategoryProcessorCategory LogsCategoryProcessorType LogsDateRemapper LogsDateRemapperType LogsExclusion LogsExclusionFilter LogsFilter LogsGeoIPParser LogsGeoIPParserType LogsGrokParser LogsGrokParserRules LogsGrokParserType LogsIndex LogsIndexListResponse LogsIndexUpdateRequest LogsIndexesOrder LogsListRequest LogsListRequestTime LogsListResponse LogsLookupProcessor LogsLookupProcessorType LogsMessageRemapper LogsMessageRemapperType LogsPipeline LogsPipelineList LogsPipelineProcessor LogsPipelineProcessorType LogsPipelinesOrder LogsProcessor LogsQueryCompute LogsRetentionAggSumUsage LogsRetentionSumUsage LogsServiceRemapper LogsServiceRemapperType LogsSort LogsStatusRemapper LogsStatusRemapperType LogsStringBuilderProcessor LogsStringBuilderProcessorType LogsTraceRemapper LogsTraceRemapperType LogsURLParser LogsURLParserType LogsUserAgentParser LogsUserAgentParserType MetricMetadata MetricSearchResponse MetricSearchResponseResults MetricsListResponse MetricsPayload MetricsQueryMetadata MetricsQueryResponse MetricsQueryUnit Monitor MonitorDeviceID MonitorOptions MonitorOptionsAggregation MonitorOverallStates MonitorState MonitorStateGroup MonitorSummaryWidgetDefinition MonitorSummaryWidgetDefinitionType MonitorThresholdWindowOptions MonitorThresholds MonitorType MonitorUpdateRequest NoteWidgetDefinition NoteWidgetDefinitionType Organization OrganizationBilling OrganizationCreateBody OrganizationCreateResponse OrganizationListResponse OrganizationResponse OrganizationSettings OrganizationSettingsSaml OrganizationSettingsSamlAutocreateUsersDomains OrganizationSettingsSamlIdpInitiatedLogin OrganizationSettingsSamlStrictMode OrganizationSubscription PagerDutyService PagerDutyServiceKey PagerDutyServiceName Point ProcessQueryDefinition QuerySortOrder QueryValueWidgetDefinition QueryValueWidgetDefinitionType QueryValueWidgetRequest SLOBulkDelete SLOBulkDeleteError SLOBulkDeleteResponse SLOBulkDeleteResponseData SLOCorrection SLOCorrectionCategory SLOCorrectionCreateData SLOCorrectionCreateRequest SLOCorrectionCreateRequestAttributes SLOCorrectionListResponse SLOCorrectionResponse SLOCorrectionResponseAttributes SLOCorrectionType SLOCorrectionUpdateData SLOCorrectionUpdateRequest SLOCorrectionUpdateRequestAttributes SLODeleteResponse SLOErrorBudgetRemainingData SLOErrorTimeframe SLOHistoryMetrics SLOHistoryMetricsSeries SLOHistoryMetricsSeriesMetadata SLOHistoryMetricsSeriesMetadataUnit SLOHistoryResponse SLOHistoryResponseData SLOHistoryResponseError SLOHistorySLIData SLOListResponse SLOListResponseMetadata SLOListResponseMetadataPage SLOResponse SLOResponseData SLOThreshold SLOTimeframe SLOType SLOTypeNumeric SLOWidgetDefinition SLOWidgetDefinitionType ScatterPlotRequest ScatterPlotWidgetDefinition ScatterPlotWidgetDefinitionRequests ScatterPlotWidgetDefinitionType Series ServiceCheck ServiceCheckStatus ServiceChecks ServiceLevelObjective ServiceLevelObjectiveQuery ServiceLevelObjectiveRequest ServiceMapWidgetDefinition ServiceMapWidgetDefinitionType ServiceSummaryWidgetDefinition ServiceSummaryWidgetDefinitionType SlackIntegrationChannel SlackIntegrationChannelDisplay SlackIntegrationChannels SyntheticsAPIStep SyntheticsAPIStepSubtype SyntheticsAPITest SyntheticsAPITestConfig SyntheticsAPITestResultData SyntheticsAPITestResultFull SyntheticsAPITestResultFullCheck SyntheticsAPITestResultShort SyntheticsAPITestResultShortResult SyntheticsAPITestType SyntheticsAssertion SyntheticsAssertionJSONPathOperator SyntheticsAssertionJSONPathTarget SyntheticsAssertionJSONPathTargetTarget SyntheticsAssertionOperator SyntheticsAssertionTarget SyntheticsAssertionType SyntheticsBasicAuth SyntheticsBrowserError SyntheticsBrowserErrorType SyntheticsBrowserTest SyntheticsBrowserTestConfig SyntheticsBrowserTestResultData SyntheticsBrowserTestResultFull SyntheticsBrowserTestResultFullCheck SyntheticsBrowserTestResultShort SyntheticsBrowserTestResultShortResult SyntheticsBrowserTestType SyntheticsBrowserVariable SyntheticsBrowserVariableType SyntheticsCITest SyntheticsCITestBody SyntheticsCITestMetadata SyntheticsCITestMetadataCi SyntheticsCITestMetadataGit SyntheticsCheckType SyntheticsConfigVariable SyntheticsConfigVariableType SyntheticsCoreWebVitals SyntheticsDeleteTestsPayload SyntheticsDeleteTestsResponse SyntheticsDeletedTest SyntheticsDevice SyntheticsDeviceID SyntheticsErrorCode SyntheticsGetAPITestLatestResultsResponse SyntheticsGetBrowserTestLatestResultsResponse SyntheticsGlobalVariable SyntheticsGlobalVariableParseTestOptions SyntheticsGlobalVariableParseTestOptionsType SyntheticsGlobalVariableParserType SyntheticsGlobalVariableValue SyntheticsListTestsResponse SyntheticsLocation SyntheticsLocations SyntheticsParsingOptions SyntheticsPlayingTab SyntheticsPrivateLocation SyntheticsPrivateLocationCreationResponse SyntheticsPrivateLocationCreationResponseResultEncryption SyntheticsPrivateLocationSecrets SyntheticsPrivateLocationSecretsAuthentication SyntheticsPrivateLocationSecretsConfigDecryption SyntheticsSSLCertificate SyntheticsSSLCertificateIssuer SyntheticsSSLCertificateSubject SyntheticsStep SyntheticsStepDetail SyntheticsStepDetailWarning SyntheticsStepType SyntheticsTestConfig SyntheticsTestDetails SyntheticsTestDetailsSubType SyntheticsTestDetailsType SyntheticsTestHeaders SyntheticsTestMonitorStatus SyntheticsTestOptions SyntheticsTestOptionsMonitorOptions SyntheticsTestOptionsRetry SyntheticsTestPauseStatus SyntheticsTestProcessStatus SyntheticsTestRequest SyntheticsTestRequestCertificate SyntheticsTestRequestCertificateItem SyntheticsTickInterval SyntheticsTiming SyntheticsTriggerCITestLocation SyntheticsTriggerCITestRunResult SyntheticsTriggerCITestsResponse SyntheticsUpdateTestPauseStatusPayload SyntheticsVariableParser SyntheticsWarningType TableWidgetCellDisplayMode TableWidgetDefinition TableWidgetDefinitionType TableWidgetHasSearchBar TableWidgetRequest TagToHosts TargetFormatType TimeseriesWidgetDefinition TimeseriesWidgetDefinitionType TimeseriesWidgetExpressionAlias TimeseriesWidgetLegendColumn TimeseriesWidgetLegendLayout TimeseriesWidgetRequest ToplistWidgetDefinition ToplistWidgetDefinitionType ToplistWidgetRequest UsageAnalyzedLogsHour UsageAnalyzedLogsResponse UsageAttributionAggregates UsageAttributionAggregatesBody UsageAttributionBody UsageAttributionMetadata UsageAttributionPagination UsageAttributionResponse UsageAttributionSort UsageAttributionTagNames UsageAttributionValues UsageBillableSummaryBody UsageBillableSummaryHour UsageBillableSummaryKeys UsageBillableSummaryResponse UsageComplianceHour UsageComplianceResponse UsageCustomReportsAttributes UsageCustomReportsData UsageCustomReportsMeta UsageCustomReportsPage UsageCustomReportsResponse UsageFargateHour UsageFargateResponse UsageHostHour UsageHostsResponse UsageIncidentManagementHour UsageIncidentManagementResponse UsageIndexedSpansHour UsageIndexedSpansResponse UsageIngestedSpansHour UsageIngestedSpansResponse UsageIoTHour UsageIoTResponse UsageLambdaHour UsageLambdaResponse UsageLogsByIndexHour UsageLogsByIndexResponse UsageLogsByRetentionHour UsageLogsByRetentionResponse UsageLogsHour UsageLogsResponse UsageMetricCategory UsageNetworkFlowsHour UsageNetworkFlowsResponse UsageNetworkHostsHour UsageNetworkHostsResponse UsageProfilingHour UsageProfilingResponse UsageReportsType UsageRumSessionsHour UsageRumSessionsResponse UsageSNMPHour UsageSNMPResponse UsageSort UsageSortDirection UsageSpecifiedCustomReportsAttributes UsageSpecifiedCustomReportsData UsageSpecifiedCustomReportsMeta UsageSpecifiedCustomReportsPage UsageSpecifiedCustomReportsResponse UsageSummaryDate UsageSummaryDateOrg UsageSummaryResponse UsageSyntheticsAPIHour UsageSyntheticsAPIResponse UsageSyntheticsBrowserHour UsageSyntheticsBrowserResponse UsageSyntheticsHour UsageSyntheticsResponse UsageTimeseriesHour UsageTimeseriesResponse UsageTopAvgMetricsHour UsageTopAvgMetricsMetadata UsageTopAvgMetricsResponse UsageTraceHour UsageTraceResponse UsageTracingWithoutLimitsHour UsageTracingWithoutLimitsResponse User UserDisableResponse UserListResponse UserResponse Widget WidgetAggregator WidgetAxis WidgetChangeType WidgetColorPreference WidgetComparator WidgetCompareTo WidgetConditionalFormat WidgetCustomLink WidgetDefinition WidgetDisplayType WidgetEvent WidgetEventSize WidgetFieldSort WidgetFormula WidgetFormulaLimit WidgetGrouping WidgetHorizontalAlign WidgetImageSizing WidgetLayout WidgetLayoutType WidgetLineType WidgetLineWidth WidgetLiveSpan WidgetMargin WidgetMarker WidgetMessageDisplay WidgetMonitorSummaryDisplayFormat WidgetMonitorSummarySort WidgetNodeType WidgetOrderBy WidgetPalette WidgetRequestStyle WidgetServiceSummaryDisplayFormat WidgetSizeFormat WidgetSort WidgetStyle WidgetSummaryType WidgetTextAlign WidgetTickEdge WidgetTime WidgetTimeWindows WidgetVerticalAlign WidgetViewMode WidgetVizType","title":"Documentation For Models"},{"location":"v1/#documentation-for-authorization","text":"","title":"Documentation For Authorization"},{"location":"v1/#apikeyauth","text":"Type : API key API key parameter name : DD-API-KEY Location : HTTP header","title":"apiKeyAuth"},{"location":"v1/#apikeyauthquery","text":"Type : API key API key parameter name : api_key Location : URL query string","title":"apiKeyAuthQuery"},{"location":"v1/#appkeyauth","text":"Type : API key API key parameter name : DD-APPLICATION-KEY Location : HTTP header","title":"appKeyAuth"},{"location":"v1/#appkeyauthquery","text":"Type : API key API key parameter name : application_key Location : URL query string","title":"appKeyAuthQuery"},{"location":"v1/#author","text":"support@datadoghq.com","title":"Author"},{"location":"v1/#notes-for-large-openapi-documents","text":"If the OpenAPI document is large, imports in datadog_api_client.v1.apis and datadog_api_client.v1.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v1.api.default_api import DefaultApi - from datadog_api_client.v1.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v1 from datadog_api_client.v1.apis import * from datadog_api_client.v1.models import *","title":"Notes for Large OpenAPI documents"},{"location":"v1/APIErrorResponse/","text":"APIErrorResponse Error response object. Properties Name Type Description Notes errors [str] Array of errors returned by the API. [Back to Model list] [Back to API list] [Back to README]","title":"APIErrorResponse"},{"location":"v1/APIErrorResponse/#apierrorresponse","text":"Error response object.","title":"APIErrorResponse"},{"location":"v1/APIErrorResponse/#properties","text":"Name Type Description Notes errors [str] Array of errors returned by the API. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccount/","text":"AWSAccount Returns the AWS account associated with this integration. Properties Name Type Description Notes access_key_id str Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. [optional] account_id str Your AWS Account ID without dashes. [optional] account_specific_namespace_rules {str: (bool,)} 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] excluded_regions [str] An array of AWS regions to exclude from metrics collection. [optional] filter_tags [str] 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 [str] Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. [optional] role_name str Your Datadog role delegation name. [optional] secret_access_key str Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccount"},{"location":"v1/AWSAccount/#awsaccount","text":"Returns the AWS account associated with this integration.","title":"AWSAccount"},{"location":"v1/AWSAccount/#properties","text":"Name Type Description Notes access_key_id str Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. [optional] account_id str Your AWS Account ID without dashes. [optional] account_specific_namespace_rules {str: (bool,)} 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] excluded_regions [str] An array of AWS regions to exclude from metrics collection. [optional] filter_tags [str] 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 [str] Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. [optional] role_name str Your Datadog role delegation name. [optional] secret_access_key str Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccountAndLambdaRequest/","text":"AWSAccountAndLambdaRequest AWS account ID and Lambda ARN. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. lambda_arn str ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccountAndLambdaRequest"},{"location":"v1/AWSAccountAndLambdaRequest/#awsaccountandlambdarequest","text":"AWS account ID and Lambda ARN.","title":"AWSAccountAndLambdaRequest"},{"location":"v1/AWSAccountAndLambdaRequest/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. lambda_arn str ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccountCreateResponse/","text":"AWSAccountCreateResponse The Response returned by the AWS Create Account call. Properties Name Type Description Notes external_id str AWS external_id. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccountCreateResponse"},{"location":"v1/AWSAccountCreateResponse/#awsaccountcreateresponse","text":"The Response returned by the AWS Create Account call.","title":"AWSAccountCreateResponse"},{"location":"v1/AWSAccountCreateResponse/#properties","text":"Name Type Description Notes external_id str AWS external_id. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSAccountListResponse/","text":"AWSAccountListResponse List of enabled AWS accounts. Properties Name Type Description Notes accounts [AWSAccount] List of enabled AWS accounts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSAccountListResponse"},{"location":"v1/AWSAccountListResponse/#awsaccountlistresponse","text":"List of enabled AWS accounts.","title":"AWSAccountListResponse"},{"location":"v1/AWSAccountListResponse/#properties","text":"Name Type Description Notes accounts [AWSAccount] List of enabled AWS accounts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSIntegrationApi/","text":"datadog_api_client.v1.AWSIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_aws_account POST /api/v1/integration/aws Create an AWS integration create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules list_aws_accounts GET /api/v1/integration/aws List all AWS integrations list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters update_aws_account PUT /api/v1/integration/aws Update an AWS integration create_aws_account AWSAccountCreateResponse create_aws_account(body) Create an AWS integration Create a Datadog-Amazon Web Services integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount AWS Request Object Return type AWSAccountCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_aws_tag_filter {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_tag_filter(body) Set an AWS tag filter Set an AWS tag filter. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterCreateRequest( account_id=\"1234567\", namespace=AWSNamespace(\"elb\"), tag_filter_str=\"prod*\", ) # AWSTagFilterCreateRequest | 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`. # example passing only required values which don't have defaults set try: # Set an AWS tag filter api_response = api_instance.create_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_tag_filter: %s\\n\" % e) Parameters Name Type Description Notes body AWSTagFilterCreateRequest 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 {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_new_aws_external_id AWSAccountCreateResponse create_new_aws_external_id(body) Generate a new external ID Generate a new AWS external ID for a given AWS account ID and role name pair. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://github.com/DataDog/documentation/blob/master/integrations/amazon_web_services/#installation). # example passing only required values which don't have defaults set try: # Generate a new external ID api_response = api_instance.create_new_aws_external_id(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_new_aws_external_id: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount Your Datadog role delegation name. For more information about your AWS account Role name, see the Datadog AWS integration configuration info . Return type AWSAccountCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_aws_account {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_account(body) Delete an AWS integration Delete a Datadog-AWS integration matching the specified account_id and role_name parameters . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object # example passing only required values which don't have defaults set try: # Delete an AWS integration api_response = api_instance.delete_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_account: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount AWS request object Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_aws_tag_filter {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_tag_filter(body) Delete a tag filtering entry Delete a tag filtering entry. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterDeleteRequest( account_id=\"FAKEAC0FAKEAC2FAKEAC\", namespace=AWSNamespace(\"elb\"), ) # AWSTagFilterDeleteRequest | Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. # example passing only required values which don't have defaults set try: # Delete a tag filtering entry api_response = api_instance.delete_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_tag_filter: %s\\n\" % e) Parameters Name Type Description Notes body AWSTagFilterDeleteRequest Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_available_aws_namespaces [str] list_available_aws_namespaces() List namespace rules List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List namespace rules api_response = api_instance.list_available_aws_namespaces() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_available_aws_namespaces: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type [str] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_accounts AWSAccountListResponse list_aws_accounts() List all AWS integrations List all Datadog-AWS integrations available in your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that matches this role_name. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all AWS integrations api_response = api_instance.list_aws_accounts(account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_accounts: %s\\n\" % e) Parameters Name Type Description Notes account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that matches this role_name. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. [optional] Return type AWSAccountListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_tag_filters AWSTagFilterListResponse list_aws_tag_filters(account_id) Get all AWS tag filters Get all AWS tag filters. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS filters that matches this `account_id`. # example passing only required values which don't have defaults set try: # Get all AWS tag filters api_response = api_instance.list_aws_tag_filters(account_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_tag_filters: %s\\n\" % e) Parameters Name Type Description Notes account_id str Only return AWS filters that matches this `account_id`. Return type AWSTagFilterListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_aws_account {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_aws_account(body) Update an AWS integration Update a Datadog-Amazon Web Services integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. (optional) # example passing only required values which don't have defaults set try: # Update an AWS integration api_response = api_instance.update_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update an AWS integration api_response = api_instance.update_aws_account(body, account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccount AWS request object account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. [optional] Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AWSIntegrationApi"},{"location":"v1/AWSIntegrationApi/#datadog_api_clientv1awsintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_aws_account POST /api/v1/integration/aws Create an AWS integration create_aws_tag_filter POST /api/v1/integration/aws/filtering Set an AWS tag filter create_new_aws_external_id PUT /api/v1/integration/aws/generate_new_external_id Generate a new external ID delete_aws_account DELETE /api/v1/integration/aws Delete an AWS integration delete_aws_tag_filter DELETE /api/v1/integration/aws/filtering Delete a tag filtering entry list_available_aws_namespaces GET /api/v1/integration/aws/available_namespace_rules List namespace rules list_aws_accounts GET /api/v1/integration/aws List all AWS integrations list_aws_tag_filters GET /api/v1/integration/aws/filtering Get all AWS tag filters update_aws_account PUT /api/v1/integration/aws Update an AWS integration","title":"datadog_api_client.v1.AWSIntegrationApi"},{"location":"v1/AWSIntegrationApi/#create_aws_account","text":"AWSAccountCreateResponse create_aws_account(body) Create an AWS integration Create a Datadog-Amazon Web Services integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication.","title":"create_aws_account"},{"location":"v1/AWSIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS Request Object # example passing only required values which don't have defaults set try: # Create an AWS integration api_response = api_instance.create_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_account: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters","text":"Name Type Description Notes body AWSAccount AWS Request Object","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type","text":"AWSAccountCreateResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#create_aws_tag_filter","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_tag_filter(body) Set an AWS tag filter Set an AWS tag filter.","title":"create_aws_tag_filter"},{"location":"v1/AWSIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterCreateRequest( account_id=\"1234567\", namespace=AWSNamespace(\"elb\"), tag_filter_str=\"prod*\", ) # AWSTagFilterCreateRequest | 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`. # example passing only required values which don't have defaults set try: # Set an AWS tag filter api_response = api_instance.create_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_aws_tag_filter: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_1","text":"Name Type Description Notes body AWSTagFilterCreateRequest 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`.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#create_new_aws_external_id","text":"AWSAccountCreateResponse create_new_aws_external_id(body) Generate a new external ID Generate a new AWS external ID for a given AWS account ID and role name pair.","title":"create_new_aws_external_id"},{"location":"v1/AWSIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://github.com/DataDog/documentation/blob/master/integrations/amazon_web_services/#installation). # example passing only required values which don't have defaults set try: # Generate a new external ID api_response = api_instance.create_new_aws_external_id(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->create_new_aws_external_id: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_2","text":"Name Type Description Notes body AWSAccount Your Datadog role delegation name. For more information about your AWS account Role name, see the Datadog AWS integration configuration info .","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_2","text":"AWSAccountCreateResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#delete_aws_account","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_account(body) Delete an AWS integration Delete a Datadog-AWS integration matching the specified account_id and role_name parameters .","title":"delete_aws_account"},{"location":"v1/AWSIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object # example passing only required values which don't have defaults set try: # Delete an AWS integration api_response = api_instance.delete_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_account: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_3","text":"Name Type Description Notes body AWSAccount AWS request object","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#delete_aws_tag_filter","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_tag_filter(body) Delete a tag filtering entry Delete a tag filtering entry.","title":"delete_aws_tag_filter"},{"location":"v1/AWSIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSTagFilterDeleteRequest( account_id=\"FAKEAC0FAKEAC2FAKEAC\", namespace=AWSNamespace(\"elb\"), ) # AWSTagFilterDeleteRequest | Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. # example passing only required values which don't have defaults set try: # Delete a tag filtering entry api_response = api_instance.delete_aws_tag_filter(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->delete_aws_tag_filter: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_4","text":"Name Type Description Notes body AWSTagFilterDeleteRequest Delete a tag filtering entry for a given AWS account and `dd-aws` namespace.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_4","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#list_available_aws_namespaces","text":"[str] list_available_aws_namespaces() List namespace rules List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.","title":"list_available_aws_namespaces"},{"location":"v1/AWSIntegrationApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List namespace rules api_response = api_instance.list_available_aws_namespaces() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_available_aws_namespaces: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_5","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_5","text":"[str]","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#list_aws_accounts","text":"AWSAccountListResponse list_aws_accounts() List all AWS integrations List all Datadog-AWS integrations available in your Datadog organization.","title":"list_aws_accounts"},{"location":"v1/AWSIntegrationApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that matches this role_name. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all AWS integrations api_response = api_instance.list_aws_accounts(account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_accounts: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_6","text":"Name Type Description Notes account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that matches this role_name. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. [optional]","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_6","text":"AWSAccountListResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#list_aws_tag_filters","text":"AWSTagFilterListResponse list_aws_tag_filters(account_id) Get all AWS tag filters Get all AWS tag filters.","title":"list_aws_tag_filters"},{"location":"v1/AWSIntegrationApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) account_id = \"account_id_example\" # str | Only return AWS filters that matches this `account_id`. # example passing only required values which don't have defaults set try: # Get all AWS tag filters api_response = api_instance.list_aws_tag_filters(account_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->list_aws_tag_filters: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_7","text":"Name Type Description Notes account_id str Only return AWS filters that matches this `account_id`.","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_7","text":"AWSTagFilterListResponse","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSIntegrationApi/#update_aws_account","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_aws_account(body) Update an AWS integration Update a Datadog-Amazon Web Services integration.","title":"update_aws_account"},{"location":"v1/AWSIntegrationApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_integration_api.AWSIntegrationApi(api_client) body = AWSAccount( access_key_id=\"access_key_id_example\", account_id=\"1234567\", account_specific_namespace_rules={ \"key\": True, }, excluded_regions=[\"us-east-1\",\"us-west-2\"], filter_tags=[\":\"], host_tags=[\":\"], role_name=\"DatadogAWSIntegrationRole\", secret_access_key=\"secret_access_key_example\", ) # AWSAccount | AWS request object account_id = \"account_id_example\" # str | Only return AWS accounts that matches this `account_id`. (optional) role_name = \"role_name_example\" # str | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. (optional) access_key_id = \"access_key_id_example\" # str | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. (optional) # example passing only required values which don't have defaults set try: # Update an AWS integration api_response = api_instance.update_aws_account(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update an AWS integration api_response = api_instance.update_aws_account(body, account_id=account_id, role_name=role_name, access_key_id=access_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSIntegrationApi->update_aws_account: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSIntegrationApi/#parameters_8","text":"Name Type Description Notes body AWSAccount AWS request object account_id str Only return AWS accounts that matches this `account_id`. [optional] role_name str Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. [optional] access_key_id str Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. [optional]","title":"Parameters"},{"location":"v1/AWSIntegrationApi/#return-type_8","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSIntegrationApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSIntegrationApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSIntegrationApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 409 Conflict Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsAsyncError/","text":"AWSLogsAsyncError Description of errors. Properties Name Type Description Notes code str Code properties [optional] message str Message content. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsAsyncError"},{"location":"v1/AWSLogsAsyncError/#awslogsasyncerror","text":"Description of errors.","title":"AWSLogsAsyncError"},{"location":"v1/AWSLogsAsyncError/#properties","text":"Name Type Description Notes code str Code properties [optional] message str Message content. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsAsyncResponse/","text":"AWSLogsAsyncResponse A list of all Datadog-AWS logs integrations available in your Datadog organization. Properties Name Type Description Notes errors [AWSLogsAsyncError] List of errors. [optional] status str Status of the properties. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsAsyncResponse"},{"location":"v1/AWSLogsAsyncResponse/#awslogsasyncresponse","text":"A list of all Datadog-AWS logs integrations available in your Datadog organization.","title":"AWSLogsAsyncResponse"},{"location":"v1/AWSLogsAsyncResponse/#properties","text":"Name Type Description Notes errors [AWSLogsAsyncError] List of errors. [optional] status str Status of the properties. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsIntegrationApi/","text":"datadog_api_client.v1.AWSLogsIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description 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 POST /api/v1/integration/aws/logs/services_async Check permissions for log services create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services check_aws_logs_lambda_async AWSLogsAsyncResponse check_aws_logs_lambda_async(body) Check that an AWS Lambda Function exists Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking. - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Check AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Check that an AWS Lambda Function exists api_response = api_instance.check_aws_logs_lambda_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_lambda_async: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccountAndLambdaRequest Check AWS Log Lambda Async request body. Return type AWSLogsAsyncResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] check_aws_logs_services_async AWSLogsAsyncResponse check_aws_logs_services_async(body) Check permissions for log services Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for EnableAWSLogServices . Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes. - Returns a status of created when it's checking if the permissions exists in the AWS account. - Returns a status of waiting while checking. - Returns a status of checked and ok if the Lambda exists. - Returns a status of error if the Lambda does not exist. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Check AWS Logs Async Services request body. # example passing only required values which don't have defaults set try: # Check permissions for log services api_response = api_instance.check_aws_logs_services_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_services_async: %s\\n\" % e) Parameters Name Type Description Notes body AWSLogsServicesRequest Check AWS Logs Async Services request body. Return type AWSLogsAsyncResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_aws_lambda_arn {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_lambda_arn(body) Add AWS Log Lambda ARN Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Add AWS Log Lambda ARN api_response = api_instance.create_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->create_aws_lambda_arn: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccountAndLambdaRequest AWS Log Lambda Async request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_aws_lambda_arn {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_lambda_arn(body) Delete an AWS Logs integration Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Delete AWS Lambda ARN request body. # example passing only required values which don't have defaults set try: # Delete an AWS Logs integration api_response = api_instance.delete_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->delete_aws_lambda_arn: %s\\n\" % e) Parameters Name Type Description Notes body AWSAccountAndLambdaRequest Delete AWS Lambda ARN request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] enable_aws_log_services {str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_aws_log_services(body) Enable an AWS Logs integration Enable automatic log collection for a list of services. This should be run after running CreateAWSLambdaARN to save the configuration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Enable AWS Log Services request body. # example passing only required values which don't have defaults set try: # Enable an AWS Logs integration api_response = api_instance.enable_aws_log_services(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->enable_aws_log_services: %s\\n\" % e) Parameters Name Type Description Notes body AWSLogsServicesRequest Enable AWS Log Services request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_logs_integrations [AWSLogsListResponse] list_aws_logs_integrations() List all AWS Logs integrations List all Datadog-AWS Logs integrations configured in your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all AWS Logs integrations api_response = api_instance.list_aws_logs_integrations() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_integrations: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type [AWSLogsListResponse] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_aws_logs_services [AWSLogsListServicesResponse] list_aws_logs_services() Get list of AWS log ready services Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # Get list of AWS log ready services api_response = api_instance.list_aws_logs_services() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_services: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type [AWSLogsListServicesResponse] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AWSLogsIntegrationApi"},{"location":"v1/AWSLogsIntegrationApi/#datadog_api_clientv1awslogsintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description 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 POST /api/v1/integration/aws/logs/services_async Check permissions for log services create_aws_lambda_arn POST /api/v1/integration/aws/logs Add AWS Log Lambda ARN delete_aws_lambda_arn DELETE /api/v1/integration/aws/logs Delete an AWS Logs integration enable_aws_log_services POST /api/v1/integration/aws/logs/services Enable an AWS Logs integration list_aws_logs_integrations GET /api/v1/integration/aws/logs List all AWS Logs integrations list_aws_logs_services GET /api/v1/integration/aws/logs/services Get list of AWS log ready services","title":"datadog_api_client.v1.AWSLogsIntegrationApi"},{"location":"v1/AWSLogsIntegrationApi/#check_aws_logs_lambda_async","text":"AWSLogsAsyncResponse check_aws_logs_lambda_async(body) Check that an AWS Lambda Function exists Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking. - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist.","title":"check_aws_logs_lambda_async"},{"location":"v1/AWSLogsIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Check AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Check that an AWS Lambda Function exists api_response = api_instance.check_aws_logs_lambda_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_lambda_async: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters","text":"Name Type Description Notes body AWSAccountAndLambdaRequest Check AWS Log Lambda Async request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type","text":"AWSLogsAsyncResponse","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#check_aws_logs_services_async","text":"AWSLogsAsyncResponse check_aws_logs_services_async(body) Check permissions for log services Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for EnableAWSLogServices . Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes. - Returns a status of created when it's checking if the permissions exists in the AWS account. - Returns a status of waiting while checking. - Returns a status of checked and ok if the Lambda exists. - Returns a status of error if the Lambda does not exist.","title":"check_aws_logs_services_async"},{"location":"v1/AWSLogsIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Check AWS Logs Async Services request body. # example passing only required values which don't have defaults set try: # Check permissions for log services api_response = api_instance.check_aws_logs_services_async(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->check_aws_logs_services_async: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_1","text":"Name Type Description Notes body AWSLogsServicesRequest Check AWS Logs Async Services request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_1","text":"AWSLogsAsyncResponse","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#create_aws_lambda_arn","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_lambda_arn(body) Add AWS Log Lambda ARN Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection.","title":"create_aws_lambda_arn"},{"location":"v1/AWSLogsIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | AWS Log Lambda Async request body. # example passing only required values which don't have defaults set try: # Add AWS Log Lambda ARN api_response = api_instance.create_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->create_aws_lambda_arn: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_2","text":"Name Type Description Notes body AWSAccountAndLambdaRequest AWS Log Lambda Async request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_2","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#delete_aws_lambda_arn","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_lambda_arn(body) Delete an AWS Logs integration Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account.","title":"delete_aws_lambda_arn"},{"location":"v1/AWSLogsIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSAccountAndLambdaRequest( account_id=\"1234567\", lambda_arn=\"arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest\", ) # AWSAccountAndLambdaRequest | Delete AWS Lambda ARN request body. # example passing only required values which don't have defaults set try: # Delete an AWS Logs integration api_response = api_instance.delete_aws_lambda_arn(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->delete_aws_lambda_arn: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_3","text":"Name Type Description Notes body AWSAccountAndLambdaRequest Delete AWS Lambda ARN request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#enable_aws_log_services","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_aws_log_services(body) Enable an AWS Logs integration Enable automatic log collection for a list of services. This should be run after running CreateAWSLambdaARN to save the configuration.","title":"enable_aws_log_services"},{"location":"v1/AWSLogsIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) body = AWSLogsServicesRequest( account_id=\"1234567\", services=[\"s3\",\"elb\",\"elbv2\",\"cloudfront\",\"redshift\",\"lambda\"], ) # AWSLogsServicesRequest | Enable AWS Log Services request body. # example passing only required values which don't have defaults set try: # Enable an AWS Logs integration api_response = api_instance.enable_aws_log_services(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->enable_aws_log_services: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_4","text":"Name Type Description Notes body AWSLogsServicesRequest Enable AWS Log Services request body.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_4","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#list_aws_logs_integrations","text":"[AWSLogsListResponse] list_aws_logs_integrations() List all AWS Logs integrations List all Datadog-AWS Logs integrations configured in your Datadog account.","title":"list_aws_logs_integrations"},{"location":"v1/AWSLogsIntegrationApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all AWS Logs integrations api_response = api_instance.list_aws_logs_integrations() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_integrations: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_5","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_5","text":"[AWSLogsListResponse]","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsIntegrationApi/#list_aws_logs_services","text":"[AWSLogsListServicesResponse] list_aws_logs_services() Get list of AWS log ready services Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.","title":"list_aws_logs_services"},{"location":"v1/AWSLogsIntegrationApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import aws_logs_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = aws_logs_integration_api.AWSLogsIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # Get list of AWS log ready services api_response = api_instance.list_aws_logs_services() pprint(api_response) except ApiException as e: print(\"Exception when calling AWSLogsIntegrationApi->list_aws_logs_services: %s\\n\" % e)","title":"Example"},{"location":"v1/AWSLogsIntegrationApi/#parameters_6","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AWSLogsIntegrationApi/#return-type_6","text":"[AWSLogsListServicesResponse]","title":"Return type"},{"location":"v1/AWSLogsIntegrationApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AWSLogsIntegrationApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AWSLogsIntegrationApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AWSLogsLambda/","text":"AWSLogsLambda Description of the Lambdas. Properties Name Type Description Notes arn str Available ARN IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsLambda"},{"location":"v1/AWSLogsLambda/#awslogslambda","text":"Description of the Lambdas.","title":"AWSLogsLambda"},{"location":"v1/AWSLogsLambda/#properties","text":"Name Type Description Notes arn str Available ARN IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsListResponse/","text":"AWSLogsListResponse A list of all Datadog-AWS logs integrations available in your Datadog organization. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] lambdas [AWSLogsLambda] List of ARNs configured in your Datadog account. [optional] services [str] Array of services IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsListResponse"},{"location":"v1/AWSLogsListResponse/#awslogslistresponse","text":"A list of all Datadog-AWS logs integrations available in your Datadog organization.","title":"AWSLogsListResponse"},{"location":"v1/AWSLogsListResponse/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] lambdas [AWSLogsLambda] List of ARNs configured in your Datadog account. [optional] services [str] Array of services IDs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsListServicesResponse/","text":"AWSLogsListServicesResponse The list of current AWS services for which Datadog offers automatic log collection. Properties Name Type Description Notes id str Key value in returned object. [optional] label str Name of service available for configuration with Datadog logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsListServicesResponse"},{"location":"v1/AWSLogsListServicesResponse/#awslogslistservicesresponse","text":"The list of current AWS services for which Datadog offers automatic log collection.","title":"AWSLogsListServicesResponse"},{"location":"v1/AWSLogsListServicesResponse/#properties","text":"Name Type Description Notes id str Key value in returned object. [optional] label str Name of service available for configuration with Datadog logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSLogsServicesRequest/","text":"AWSLogsServicesRequest A list of current AWS services for which Datadog offers automatic log collection. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. services [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"AWSLogsServicesRequest"},{"location":"v1/AWSLogsServicesRequest/#awslogsservicesrequest","text":"A list of current AWS services for which Datadog offers automatic log collection.","title":"AWSLogsServicesRequest"},{"location":"v1/AWSLogsServicesRequest/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. services [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSNamespace/","text":"AWSNamespace The namespace associated with the tag filter entry. Properties Name Type Description Notes value str The namespace associated with the tag filter entry. must be one of [\"elb\", \"application_elb\", \"sqs\", \"rds\", \"custom\", \"network_elb\", \"lambda\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AWSNamespace"},{"location":"v1/AWSNamespace/#awsnamespace","text":"The namespace associated with the tag filter entry.","title":"AWSNamespace"},{"location":"v1/AWSNamespace/#properties","text":"Name Type Description Notes value str The namespace associated with the tag filter entry. must be one of [\"elb\", \"application_elb\", \"sqs\", \"rds\", \"custom\", \"network_elb\", \"lambda\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilter/","text":"AWSTagFilter A tag filter. Properties Name Type Description Notes namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilter"},{"location":"v1/AWSTagFilter/#awstagfilter","text":"A tag filter.","title":"AWSTagFilter"},{"location":"v1/AWSTagFilter/#properties","text":"Name Type Description Notes namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilterCreateRequest/","text":"AWSTagFilterCreateRequest The objects used to set an AWS tag filter. Properties Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilterCreateRequest"},{"location":"v1/AWSTagFilterCreateRequest/#awstagfiltercreaterequest","text":"The objects used to set an AWS tag filter.","title":"AWSTagFilterCreateRequest"},{"location":"v1/AWSTagFilterCreateRequest/#properties","text":"Name Type Description Notes account_id str Your AWS Account ID without dashes. [optional] namespace AWSNamespace [optional] tag_filter_str str The tag filter string. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilterDeleteRequest/","text":"AWSTagFilterDeleteRequest The objects used to delete an AWS tag filter entry. Properties Name Type Description Notes account_id str The unique identifier of your AWS account. [optional] namespace AWSNamespace [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilterDeleteRequest"},{"location":"v1/AWSTagFilterDeleteRequest/#awstagfilterdeleterequest","text":"The objects used to delete an AWS tag filter entry.","title":"AWSTagFilterDeleteRequest"},{"location":"v1/AWSTagFilterDeleteRequest/#properties","text":"Name Type Description Notes account_id str The unique identifier of your AWS account. [optional] namespace AWSNamespace [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AWSTagFilterListResponse/","text":"AWSTagFilterListResponse An array of tag filter rules by namespace and tag filter string. Properties Name Type Description Notes filters [AWSTagFilter] An array of tag filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AWSTagFilterListResponse"},{"location":"v1/AWSTagFilterListResponse/#awstagfilterlistresponse","text":"An array of tag filter rules by namespace and tag filter string.","title":"AWSTagFilterListResponse"},{"location":"v1/AWSTagFilterListResponse/#properties","text":"Name Type Description Notes filters [AWSTagFilter] An array of tag filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AccessRole/","text":"AccessRole The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). Properties Name Type Description Notes value str The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). defaults to \"st\", must be one of [\"st\", \"adm\", \"ro\", \"ERROR\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AccessRole"},{"location":"v1/AccessRole/#accessrole","text":"The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).","title":"AccessRole"},{"location":"v1/AccessRole/#properties","text":"Name Type Description Notes value str The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). defaults to \"st\", must be one of [\"st\", \"adm\", \"ro\", \"ERROR\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertGraphWidgetDefinition/","text":"AlertGraphWidgetDefinition Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. Properties Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertGraphWidgetDefinitionType viz_type WidgetVizType time WidgetTime [optional] title str The title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AlertGraphWidgetDefinition"},{"location":"v1/AlertGraphWidgetDefinition/#alertgraphwidgetdefinition","text":"Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.","title":"AlertGraphWidgetDefinition"},{"location":"v1/AlertGraphWidgetDefinition/#properties","text":"Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertGraphWidgetDefinitionType viz_type WidgetVizType time WidgetTime [optional] title str The title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertGraphWidgetDefinitionType/","text":"AlertGraphWidgetDefinitionType Type of the alert graph widget. Properties Name Type Description Notes value str Type of the alert graph widget. defaults to \"alert_graph\", must be one of [\"alert_graph\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AlertGraphWidgetDefinitionType"},{"location":"v1/AlertGraphWidgetDefinitionType/#alertgraphwidgetdefinitiontype","text":"Type of the alert graph widget.","title":"AlertGraphWidgetDefinitionType"},{"location":"v1/AlertGraphWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the alert graph widget. defaults to \"alert_graph\", must be one of [\"alert_graph\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertValueWidgetDefinition/","text":"AlertValueWidgetDefinition Alert values are query values showing the current value of the metric in any monitor defined on your system. Properties Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertValueWidgetDefinitionType precision int Number of decimal to show. If not defined, will use the raw value. [optional] text_align WidgetTextAlign [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of value in the widget. [optional] unit str Unit to display with the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AlertValueWidgetDefinition"},{"location":"v1/AlertValueWidgetDefinition/#alertvaluewidgetdefinition","text":"Alert values are query values showing the current value of the metric in any monitor defined on your system.","title":"AlertValueWidgetDefinition"},{"location":"v1/AlertValueWidgetDefinition/#properties","text":"Name Type Description Notes alert_id str ID of the alert to use in the widget. type AlertValueWidgetDefinitionType precision int Number of decimal to show. If not defined, will use the raw value. [optional] text_align WidgetTextAlign [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of value in the widget. [optional] unit str Unit to display with the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AlertValueWidgetDefinitionType/","text":"AlertValueWidgetDefinitionType Type of the alert value widget. Properties Name Type Description Notes value str Type of the alert value widget. defaults to \"alert_value\", must be one of [\"alert_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"AlertValueWidgetDefinitionType"},{"location":"v1/AlertValueWidgetDefinitionType/#alertvaluewidgetdefinitiontype","text":"Type of the alert value widget.","title":"AlertValueWidgetDefinitionType"},{"location":"v1/AlertValueWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the alert value widget. defaults to \"alert_value\", must be one of [\"alert_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApiKey/","text":"ApiKey Datadog API key. Properties Name Type Description Notes created str Date of creation of the API key. optional created_by str Datadog user handle that created the API key. optional key str API key. optional name str Name of your API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApiKey"},{"location":"v1/ApiKey/#apikey","text":"Datadog API key.","title":"ApiKey"},{"location":"v1/ApiKey/#properties","text":"Name Type Description Notes created str Date of creation of the API key. optional created_by str Datadog user handle that created the API key. optional key str API key. optional name str Name of your API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApiKeyListResponse/","text":"ApiKeyListResponse List of API and application keys available for a given organization. Properties Name Type Description Notes api_keys [ApiKey] Array of API keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApiKeyListResponse"},{"location":"v1/ApiKeyListResponse/#apikeylistresponse","text":"List of API and application keys available for a given organization.","title":"ApiKeyListResponse"},{"location":"v1/ApiKeyListResponse/#properties","text":"Name Type Description Notes api_keys [ApiKey] Array of API keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApiKeyResponse/","text":"ApiKeyResponse An API key with its associated metadata. Properties Name Type Description Notes api_key ApiKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApiKeyResponse"},{"location":"v1/ApiKeyResponse/#apikeyresponse","text":"An API key with its associated metadata.","title":"ApiKeyResponse"},{"location":"v1/ApiKeyResponse/#properties","text":"Name Type Description Notes api_key ApiKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApmStatsQueryColumnType/","text":"ApmStatsQueryColumnType Column properties. Properties Name Type Description Notes name str Column name. alias str A user-assigned alias for the column. [optional] cell_display_mode TableWidgetCellDisplayMode [optional] order WidgetSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApmStatsQueryColumnType"},{"location":"v1/ApmStatsQueryColumnType/#apmstatsquerycolumntype","text":"Column properties.","title":"ApmStatsQueryColumnType"},{"location":"v1/ApmStatsQueryColumnType/#properties","text":"Name Type Description Notes name str Column name. alias str A user-assigned alias for the column. [optional] cell_display_mode TableWidgetCellDisplayMode [optional] order WidgetSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApmStatsQueryDefinition/","text":"ApmStatsQueryDefinition The APM stats query for table and distributions widgets. Properties Name Type Description Notes env str Environment name. name str Operation name associated with service. primary_tag str The organization's host group name and value. row_type ApmStatsQueryRowType service str Service name. columns [ApmStatsQueryColumnType] Column properties used by the front end for display. [optional] resource str Resource name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApmStatsQueryDefinition"},{"location":"v1/ApmStatsQueryDefinition/#apmstatsquerydefinition","text":"The APM stats query for table and distributions widgets.","title":"ApmStatsQueryDefinition"},{"location":"v1/ApmStatsQueryDefinition/#properties","text":"Name Type Description Notes env str Environment name. name str Operation name associated with service. primary_tag str The organization's host group name and value. row_type ApmStatsQueryRowType service str Service name. columns [ApmStatsQueryColumnType] Column properties used by the front end for display. [optional] resource str Resource name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApmStatsQueryRowType/","text":"ApmStatsQueryRowType The level of detail for the request. Properties Name Type Description Notes value str The level of detail for the request. must be one of [\"service\", \"resource\", \"span\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ApmStatsQueryRowType"},{"location":"v1/ApmStatsQueryRowType/#apmstatsqueryrowtype","text":"The level of detail for the request.","title":"ApmStatsQueryRowType"},{"location":"v1/ApmStatsQueryRowType/#properties","text":"Name Type Description Notes value str The level of detail for the request. must be one of [\"service\", \"resource\", \"span\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApplicationKey/","text":"ApplicationKey An application key with its associated metadata. Properties Name Type Description Notes hash str Hash of an application key. optional name str Name of an application key. [optional] owner str Owner of an application key. optional [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKey"},{"location":"v1/ApplicationKey/#applicationkey","text":"An application key with its associated metadata.","title":"ApplicationKey"},{"location":"v1/ApplicationKey/#properties","text":"Name Type Description Notes hash str Hash of an application key. optional name str Name of an application key. [optional] owner str Owner of an application key. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApplicationKeyListResponse/","text":"ApplicationKeyListResponse An application key response. Properties Name Type Description Notes application_keys [ApplicationKey] Array of application keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyListResponse"},{"location":"v1/ApplicationKeyListResponse/#applicationkeylistresponse","text":"An application key response.","title":"ApplicationKeyListResponse"},{"location":"v1/ApplicationKeyListResponse/#properties","text":"Name Type Description Notes application_keys [ApplicationKey] Array of application keys. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ApplicationKeyResponse/","text":"ApplicationKeyResponse An application key response. Properties Name Type Description Notes application_key ApplicationKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyResponse"},{"location":"v1/ApplicationKeyResponse/#applicationkeyresponse","text":"An application key response.","title":"ApplicationKeyResponse"},{"location":"v1/ApplicationKeyResponse/#properties","text":"Name Type Description Notes application_key ApplicationKey [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AuthenticationApi/","text":"datadog_api_client.v1.AuthenticationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description validate GET /api/v1/validate Validate API key validate AuthenticationValidationResponse validate() Validate API key Check if the API key (not the APP key) is valid. If invalid, a 403 is returned. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import authentication_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = authentication_api.AuthenticationApi(api_client) # example, this endpoint has no required or optional parameters try: # Validate API key api_response = api_instance.validate() pprint(api_response) except ApiException as e: print(\"Exception when calling AuthenticationApi->validate: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type AuthenticationValidationResponse Authorization apiKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AuthenticationApi"},{"location":"v1/AuthenticationApi/#datadog_api_clientv1authenticationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description validate GET /api/v1/validate Validate API key","title":"datadog_api_client.v1.AuthenticationApi"},{"location":"v1/AuthenticationApi/#validate","text":"AuthenticationValidationResponse validate() Validate API key Check if the API key (not the APP key) is valid. If invalid, a 403 is returned.","title":"validate"},{"location":"v1/AuthenticationApi/#example","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import authentication_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = authentication_api.AuthenticationApi(api_client) # example, this endpoint has no required or optional parameters try: # Validate API key api_response = api_instance.validate() pprint(api_response) except ApiException as e: print(\"Exception when calling AuthenticationApi->validate: %s\\n\" % e)","title":"Example"},{"location":"v1/AuthenticationApi/#parameters","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AuthenticationApi/#return-type","text":"AuthenticationValidationResponse","title":"Return type"},{"location":"v1/AuthenticationApi/#authorization","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/AuthenticationApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AuthenticationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AuthenticationValidationResponse/","text":"AuthenticationValidationResponse Represent validation endpoint responses. Properties Name Type Description Notes valid bool Return `true` if the authentication response is valid. optional [Back to Model list] [Back to API list] [Back to README]","title":"AuthenticationValidationResponse"},{"location":"v1/AuthenticationValidationResponse/#authenticationvalidationresponse","text":"Represent validation endpoint responses.","title":"AuthenticationValidationResponse"},{"location":"v1/AuthenticationValidationResponse/#properties","text":"Name Type Description Notes valid bool Return `true` if the authentication response is valid. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AzureAccount/","text":"AzureAccount Datadog-Azure integrations configured for your organization. Properties Name Type Description Notes client_id str Your Azure web application ID. [optional] client_secret str Your Azure web application secret key. [optional] errors [str] Errors in your configuration. [optional] host_filters str 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 str Your New Azure web application ID. [optional] new_tenant_name str Your New Azure Active Directory ID. [optional] tenant_name str Your Azure Active Directory ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"AzureAccount"},{"location":"v1/AzureAccount/#azureaccount","text":"Datadog-Azure integrations configured for your organization.","title":"AzureAccount"},{"location":"v1/AzureAccount/#properties","text":"Name Type Description Notes client_id str Your Azure web application ID. [optional] client_secret str Your Azure web application secret key. [optional] errors [str] Errors in your configuration. [optional] host_filters str 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 str Your New Azure web application ID. [optional] new_tenant_name str Your New Azure Active Directory ID. [optional] tenant_name str Your Azure Active Directory ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AzureAccountListResponse/","text":"AzureAccountListResponse Accounts configured for your organization. Properties Name Type Description Notes value [AzureAccount] Accounts configured for your organization. [Back to Model list] [Back to API list] [Back to README]","title":"AzureAccountListResponse"},{"location":"v1/AzureAccountListResponse/#azureaccountlistresponse","text":"Accounts configured for your organization.","title":"AzureAccountListResponse"},{"location":"v1/AzureAccountListResponse/#properties","text":"Name Type Description Notes value [AzureAccount] Accounts configured for your organization. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/AzureIntegrationApi/","text":"datadog_api_client.v1.AzureIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_azure_integration POST /api/v1/integration/azure Create an Azure integration delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration list_azure_integration GET /api/v1/integration/azure List all Azure integrations update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters update_azure_integration PUT /api/v1/integration/azure Update an Azure integration create_azure_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_azure_integration(body) Create an Azure integration Create a Datadog-Azure integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. Using the PUT method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Create a Datadog-Azure integration for your Datadog account request body. # example passing only required values which don't have defaults set try: # Create an Azure integration api_response = api_instance.create_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->create_azure_integration: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Create a Datadog-Azure integration for your Datadog account request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_azure_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_azure_integration(body) Delete an Azure integration Delete a given Datadog-Azure integration from your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Delete a given Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Delete an Azure integration api_response = api_instance.delete_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->delete_azure_integration: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Delete a given Datadog-Azure integration request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_azure_integration AzureAccountListResponse list_azure_integration() List all Azure integrations List all Datadog-Azure integrations configured in your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all Azure integrations api_response = api_instance.list_azure_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->list_azure_integration: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type AzureAccountListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_azure_host_filters {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_host_filters(body) Update Azure integration host filters Update the defined list of host filters for a given Datadog-Azure integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration's host filters request body. # example passing only required values which don't have defaults set try: # Update Azure integration host filters api_response = api_instance.update_azure_host_filters(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_host_filters: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Update a Datadog-Azure integration's host filters request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_azure_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_integration(body) Update an Azure integration Update a Datadog-Azure integration. Requires an existing tenant_name and client_id . Any other fields supplied will overwrite existing values. To overwrite tenant_name or client_id , use new_tenant_name and new_client_id . To leave a field unchanged, do not supply that field in the payload. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Update an Azure integration api_response = api_instance.update_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_integration: %s\\n\" % e) Parameters Name Type Description Notes body AzureAccount Update a Datadog-Azure integration request body. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.AzureIntegrationApi"},{"location":"v1/AzureIntegrationApi/#datadog_api_clientv1azureintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_azure_integration POST /api/v1/integration/azure Create an Azure integration delete_azure_integration DELETE /api/v1/integration/azure Delete an Azure integration list_azure_integration GET /api/v1/integration/azure List all Azure integrations update_azure_host_filters POST /api/v1/integration/azure/host_filters Update Azure integration host filters update_azure_integration PUT /api/v1/integration/azure Update an Azure integration","title":"datadog_api_client.v1.AzureIntegrationApi"},{"location":"v1/AzureIntegrationApi/#create_azure_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_azure_integration(body) Create an Azure integration Create a Datadog-Azure integration. Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. Using the PUT method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"create_azure_integration"},{"location":"v1/AzureIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Create a Datadog-Azure integration for your Datadog account request body. # example passing only required values which don't have defaults set try: # Create an Azure integration api_response = api_instance.create_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->create_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters","text":"Name Type Description Notes body AzureAccount Create a Datadog-Azure integration for your Datadog account request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#delete_azure_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_azure_integration(body) Delete an Azure integration Delete a given Datadog-Azure integration from your Datadog account.","title":"delete_azure_integration"},{"location":"v1/AzureIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Delete a given Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Delete an Azure integration api_response = api_instance.delete_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->delete_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_1","text":"Name Type Description Notes body AzureAccount Delete a given Datadog-Azure integration request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#list_azure_integration","text":"AzureAccountListResponse list_azure_integration() List all Azure integrations List all Datadog-Azure integrations configured in your Datadog account.","title":"list_azure_integration"},{"location":"v1/AzureIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all Azure integrations api_response = api_instance.list_azure_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->list_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_2","text":"AzureAccountListResponse","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#update_azure_host_filters","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_host_filters(body) Update Azure integration host filters Update the defined list of host filters for a given Datadog-Azure integration.","title":"update_azure_host_filters"},{"location":"v1/AzureIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration's host filters request body. # example passing only required values which don't have defaults set try: # Update Azure integration host filters api_response = api_instance.update_azure_host_filters(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_host_filters: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_3","text":"Name Type Description Notes body AzureAccount Update a Datadog-Azure integration's host filters request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/AzureIntegrationApi/#update_azure_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_integration(body) Update an Azure integration Update a Datadog-Azure integration. Requires an existing tenant_name and client_id . Any other fields supplied will overwrite existing values. To overwrite tenant_name or client_id , use new_tenant_name and new_client_id . To leave a field unchanged, do not supply that field in the payload.","title":"update_azure_integration"},{"location":"v1/AzureIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import azure_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = azure_integration_api.AzureIntegrationApi(api_client) body = AzureAccount( client_id=\"testc7f6-1234-5678-9101-3fcbf464test\", client_secret=\"testingx./Sw*g/Y33t..R1cH+hScMDt\", errors=[\"*\"], host_filters=\"key:value,filter:example\", new_client_id=\"new1c7f6-1234-5678-9101-3fcbf464test\", new_tenant_name=\"new1c44-1234-5678-9101-cc00736ftest\", tenant_name=\"testc44-1234-5678-9101-cc00736ftest\", ) # AzureAccount | Update a Datadog-Azure integration request body. # example passing only required values which don't have defaults set try: # Update an Azure integration api_response = api_instance.update_azure_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling AzureIntegrationApi->update_azure_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/AzureIntegrationApi/#parameters_4","text":"Name Type Description Notes body AzureAccount Update a Datadog-Azure integration request body.","title":"Parameters"},{"location":"v1/AzureIntegrationApi/#return-type_4","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/AzureIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/AzureIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/AzureIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/CancelDowntimesByScopeRequest/","text":"CancelDowntimesByScopeRequest Cancel downtimes according to scope. Properties Name Type Description Notes scope str 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`). [Back to Model list] [Back to API list] [Back to README]","title":"CancelDowntimesByScopeRequest"},{"location":"v1/CancelDowntimesByScopeRequest/#canceldowntimesbyscoperequest","text":"Cancel downtimes according to scope.","title":"CancelDowntimesByScopeRequest"},{"location":"v1/CancelDowntimesByScopeRequest/#properties","text":"Name Type Description Notes scope str 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`). [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CanceledDowntimesIds/","text":"CanceledDowntimesIds Object containing array of IDs of canceled downtimes. Properties Name Type Description Notes cancelled_ids [int] ID of downtimes that were canceled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CanceledDowntimesIds"},{"location":"v1/CanceledDowntimesIds/#canceleddowntimesids","text":"Object containing array of IDs of canceled downtimes.","title":"CanceledDowntimesIds"},{"location":"v1/CanceledDowntimesIds/#properties","text":"Name Type Description Notes cancelled_ids [int] ID of downtimes that were canceled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ChangeWidgetDefinition/","text":"ChangeWidgetDefinition The Change graph shows you the change in a value over the time period chosen. Properties Name Type Description Notes requests [ChangeWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type ChangeWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ChangeWidgetDefinition"},{"location":"v1/ChangeWidgetDefinition/#changewidgetdefinition","text":"The Change graph shows you the change in a value over the time period chosen.","title":"ChangeWidgetDefinition"},{"location":"v1/ChangeWidgetDefinition/#properties","text":"Name Type Description Notes requests [ChangeWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type ChangeWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ChangeWidgetDefinitionType/","text":"ChangeWidgetDefinitionType Type of the change widget. Properties Name Type Description Notes value str Type of the change widget. defaults to \"change\", must be one of [\"change\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ChangeWidgetDefinitionType"},{"location":"v1/ChangeWidgetDefinitionType/#changewidgetdefinitiontype","text":"Type of the change widget.","title":"ChangeWidgetDefinitionType"},{"location":"v1/ChangeWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the change widget. defaults to \"change\", must be one of [\"change\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ChangeWidgetRequest/","text":"ChangeWidgetRequest Updated change widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] change_type WidgetChangeType [optional] compare_to WidgetCompareTo [optional] event_query LogQueryDefinition [optional] increase_good bool Whether to show increase as good. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order_by WidgetOrderBy [optional] order_dir WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] show_present bool Whether to show the present value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ChangeWidgetRequest"},{"location":"v1/ChangeWidgetRequest/#changewidgetrequest","text":"Updated change widget.","title":"ChangeWidgetRequest"},{"location":"v1/ChangeWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] change_type WidgetChangeType [optional] compare_to WidgetCompareTo [optional] event_query LogQueryDefinition [optional] increase_good bool Whether to show increase as good. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order_by WidgetOrderBy [optional] order_dir WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] show_present bool Whether to show the present value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteMonitorResponse/","text":"CheckCanDeleteMonitorResponse Response of monitor IDs that can or can't be safely deleted. Properties Name Type Description Notes data CheckCanDeleteMonitorResponseData errors {str: ([str],)} A mapping of Monitor ID to strings denoting where it's used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteMonitorResponse"},{"location":"v1/CheckCanDeleteMonitorResponse/#checkcandeletemonitorresponse","text":"Response of monitor IDs that can or can't be safely deleted.","title":"CheckCanDeleteMonitorResponse"},{"location":"v1/CheckCanDeleteMonitorResponse/#properties","text":"Name Type Description Notes data CheckCanDeleteMonitorResponseData errors {str: ([str],)} A mapping of Monitor ID to strings denoting where it's used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteMonitorResponseData/","text":"CheckCanDeleteMonitorResponseData Wrapper object with the list of monitor IDs. Properties Name Type Description Notes ok [int] An array of of Monitor IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteMonitorResponseData"},{"location":"v1/CheckCanDeleteMonitorResponseData/#checkcandeletemonitorresponsedata","text":"Wrapper object with the list of monitor IDs.","title":"CheckCanDeleteMonitorResponseData"},{"location":"v1/CheckCanDeleteMonitorResponseData/#properties","text":"Name Type Description Notes ok [int] An array of of Monitor IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteSLOResponse/","text":"CheckCanDeleteSLOResponse A service level objective response containing the requested object. Properties Name Type Description Notes data CheckCanDeleteSLOResponseData [optional] errors {str: (str,)} A mapping of SLO id to it's current usages. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteSLOResponse"},{"location":"v1/CheckCanDeleteSLOResponse/#checkcandeletesloresponse","text":"A service level objective response containing the requested object.","title":"CheckCanDeleteSLOResponse"},{"location":"v1/CheckCanDeleteSLOResponse/#properties","text":"Name Type Description Notes data CheckCanDeleteSLOResponseData [optional] errors {str: (str,)} A mapping of SLO id to it's current usages. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckCanDeleteSLOResponseData/","text":"CheckCanDeleteSLOResponseData An array of service level objective objects. Properties Name Type Description Notes ok [str] An array of of SLO IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckCanDeleteSLOResponseData"},{"location":"v1/CheckCanDeleteSLOResponseData/#checkcandeletesloresponsedata","text":"An array of service level objective objects.","title":"CheckCanDeleteSLOResponseData"},{"location":"v1/CheckCanDeleteSLOResponseData/#properties","text":"Name Type Description Notes ok [str] An array of of SLO IDs that can be safely deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckStatusWidgetDefinition/","text":"CheckStatusWidgetDefinition Check status shows the current status or number of results for any check performed. Properties Name Type Description Notes check str Name of the check to use in the widget. grouping WidgetGrouping type CheckStatusWidgetDefinitionType group str Group reporting a single check. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"CheckStatusWidgetDefinition"},{"location":"v1/CheckStatusWidgetDefinition/#checkstatuswidgetdefinition","text":"Check status shows the current status or number of results for any check performed.","title":"CheckStatusWidgetDefinition"},{"location":"v1/CheckStatusWidgetDefinition/#properties","text":"Name Type Description Notes check str Name of the check to use in the widget. grouping WidgetGrouping type CheckStatusWidgetDefinitionType group str Group reporting a single check. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/CheckStatusWidgetDefinitionType/","text":"CheckStatusWidgetDefinitionType Type of the check status widget. Properties Name Type Description Notes value str Type of the check status widget. defaults to \"check_status\", must be one of [\"check_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"CheckStatusWidgetDefinitionType"},{"location":"v1/CheckStatusWidgetDefinitionType/#checkstatuswidgetdefinitiontype","text":"Type of the check status widget.","title":"CheckStatusWidgetDefinitionType"},{"location":"v1/CheckStatusWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the check status widget. defaults to \"check_status\", must be one of [\"check_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ContentEncoding/","text":"ContentEncoding HTTP header used to compress the media-type Properties Name Type Description Notes value str HTTP header used to compress the media-type must be one of [\"gzip\", \"deflate\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ContentEncoding"},{"location":"v1/ContentEncoding/#contentencoding","text":"HTTP header used to compress the media-type","title":"ContentEncoding"},{"location":"v1/ContentEncoding/#properties","text":"Name Type Description Notes value str HTTP header used to compress the media-type must be one of [\"gzip\", \"deflate\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Creator/","text":"Creator Object describing the creator of the shared element. Properties Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Creator"},{"location":"v1/Creator/#creator","text":"Object describing the creator of the shared element.","title":"Creator"},{"location":"v1/Creator/#properties","text":"Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Dashboard/","text":"Dashboard A dashboard is Datadog\u2019s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure. Properties Name Type Description Notes layout_type DashboardLayoutType title str Title of the dashboard. widgets [Widget] List of widgets to display on the dashboard. author_handle str Identifier of the dashboard author. optional created_at datetime Creation date of the dashboard. optional description str, none_type Description of the dashboard. [optional] id str ID of the dashboard. optional is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] if omitted the server will use the default value of False modified_at datetime Modification date of the dashboard. optional notify_list [str], none_type List of handles of users to notify when changes are made to this dashboard. [optional] reflow_type DashboardReflowType [optional] template_variable_presets [DashboardTemplateVariablePreset], none_type Array of template variables saved views. [optional] template_variables [DashboardTemplateVariable], none_type List of template variables for this dashboard. [optional] url str The URL of the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"Dashboard"},{"location":"v1/Dashboard/#dashboard","text":"A dashboard is Datadog\u2019s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.","title":"Dashboard"},{"location":"v1/Dashboard/#properties","text":"Name Type Description Notes layout_type DashboardLayoutType title str Title of the dashboard. widgets [Widget] List of widgets to display on the dashboard. author_handle str Identifier of the dashboard author. optional created_at datetime Creation date of the dashboard. optional description str, none_type Description of the dashboard. [optional] id str ID of the dashboard. optional is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] if omitted the server will use the default value of False modified_at datetime Modification date of the dashboard. optional notify_list [str], none_type List of handles of users to notify when changes are made to this dashboard. [optional] reflow_type DashboardReflowType [optional] template_variable_presets [DashboardTemplateVariablePreset], none_type Array of template variables saved views. [optional] template_variables [DashboardTemplateVariable], none_type List of template variables for this dashboard. [optional] url str The URL of the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardDeleteResponse/","text":"DashboardDeleteResponse Response from the delete dashboard call. Properties Name Type Description Notes deleted_dashboard_id str ID of the deleted dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardDeleteResponse"},{"location":"v1/DashboardDeleteResponse/#dashboarddeleteresponse","text":"Response from the delete dashboard call.","title":"DashboardDeleteResponse"},{"location":"v1/DashboardDeleteResponse/#properties","text":"Name Type Description Notes deleted_dashboard_id str ID of the deleted dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardLayoutType/","text":"DashboardLayoutType Layout type of the dashboard. Properties Name Type Description Notes value str Layout type of the dashboard. must be one of [\"ordered\", \"free\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardLayoutType"},{"location":"v1/DashboardLayoutType/#dashboardlayouttype","text":"Layout type of the dashboard.","title":"DashboardLayoutType"},{"location":"v1/DashboardLayoutType/#properties","text":"Name Type Description Notes value str Layout type of the dashboard. must be one of [\"ordered\", \"free\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardList/","text":"DashboardList Your Datadog Dashboards. Properties Name Type Description Notes name str The name of the dashboard list. author Creator [optional] created datetime Date of creation of the dashboard list. optional dashboard_count int The number of dashboards in the list. optional id int The ID of the dashboard list. optional is_favorite bool Whether or not the list is in the favorites. optional modified datetime Date of last edition of the dashboard list. optional type str The type of dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"DashboardList"},{"location":"v1/DashboardList/#dashboardlist","text":"Your Datadog Dashboards.","title":"DashboardList"},{"location":"v1/DashboardList/#properties","text":"Name Type Description Notes name str The name of the dashboard list. author Creator [optional] created datetime Date of creation of the dashboard list. optional dashboard_count int The number of dashboards in the list. optional id int The ID of the dashboard list. optional is_favorite bool Whether or not the list is in the favorites. optional modified datetime Date of last edition of the dashboard list. optional type str The type of dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardListDeleteResponse/","text":"DashboardListDeleteResponse Deleted dashboard details. Properties Name Type Description Notes deleted_dashboard_list_id int ID of the deleted dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListDeleteResponse"},{"location":"v1/DashboardListDeleteResponse/#dashboardlistdeleteresponse","text":"Deleted dashboard details.","title":"DashboardListDeleteResponse"},{"location":"v1/DashboardListDeleteResponse/#properties","text":"Name Type Description Notes deleted_dashboard_list_id int ID of the deleted dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardListListResponse/","text":"DashboardListListResponse Information on your dashboard lists. Properties Name Type Description Notes dashboard_lists [DashboardList] List of all your dashboard lists. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListListResponse"},{"location":"v1/DashboardListListResponse/#dashboardlistlistresponse","text":"Information on your dashboard lists.","title":"DashboardListListResponse"},{"location":"v1/DashboardListListResponse/#properties","text":"Name Type Description Notes dashboard_lists [DashboardList] List of all your dashboard lists. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardListsApi/","text":"datadog_api_client.v1.DashboardListsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list create_dashboard_list DashboardList create_dashboard_list(body) Create a dashboard list Create an empty dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Create a dashboard list request body. # example passing only required values which don't have defaults set try: # Create a dashboard list api_response = api_instance.create_dashboard_list(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes body DashboardList Create a dashboard list request body. Return type DashboardList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_dashboard_list DashboardListDeleteResponse delete_dashboard_list(list_id) Delete a dashboard list Delete a dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to delete. # example passing only required values which don't have defaults set try: # Delete a dashboard list api_response = api_instance.delete_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes list_id int ID of the dashboard list to delete. Return type DashboardListDeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_dashboard_list DashboardList get_dashboard_list(list_id) Get a dashboard list Fetch an existing dashboard list's definition. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to fetch. # example passing only required values which don't have defaults set try: # Get a dashboard list api_response = api_instance.get_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes list_id int ID of the dashboard list to fetch. Return type DashboardList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_dashboard_lists DashboardListListResponse list_dashboard_lists() Get all dashboard lists Fetch all of your existing dashboard list definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all dashboard lists api_response = api_instance.list_dashboard_lists() pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->list_dashboard_lists: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type DashboardListListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_dashboard_list DashboardList update_dashboard_list(list_id, body) Update a dashboard list Update the name of a dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to update. body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Update a dashboard list request body. # example passing only required values which don't have defaults set try: # Update a dashboard list api_response = api_instance.update_dashboard_list(list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list: %s\\n\" % e) Parameters Name Type Description Notes list_id int ID of the dashboard list to update. body DashboardList Update a dashboard list request body. Return type DashboardList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.DashboardListsApi"},{"location":"v1/DashboardListsApi/#datadog_api_clientv1dashboardlistsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list POST /api/v1/dashboard/lists/manual Create a dashboard list delete_dashboard_list DELETE /api/v1/dashboard/lists/manual/{list_id} Delete a dashboard list get_dashboard_list GET /api/v1/dashboard/lists/manual/{list_id} Get a dashboard list list_dashboard_lists GET /api/v1/dashboard/lists/manual Get all dashboard lists update_dashboard_list PUT /api/v1/dashboard/lists/manual/{list_id} Update a dashboard list","title":"datadog_api_client.v1.DashboardListsApi"},{"location":"v1/DashboardListsApi/#create_dashboard_list","text":"DashboardList create_dashboard_list(body) Create a dashboard list Create an empty dashboard list.","title":"create_dashboard_list"},{"location":"v1/DashboardListsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Create a dashboard list request body. # example passing only required values which don't have defaults set try: # Create a dashboard list api_response = api_instance.create_dashboard_list(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters","text":"Name Type Description Notes body DashboardList Create a dashboard list request body.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type","text":"DashboardList","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#delete_dashboard_list","text":"DashboardListDeleteResponse delete_dashboard_list(list_id) Delete a dashboard list Delete a dashboard list.","title":"delete_dashboard_list"},{"location":"v1/DashboardListsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to delete. # example passing only required values which don't have defaults set try: # Delete a dashboard list api_response = api_instance.delete_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_1","text":"Name Type Description Notes list_id int ID of the dashboard list to delete.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_1","text":"DashboardListDeleteResponse","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#get_dashboard_list","text":"DashboardList get_dashboard_list(list_id) Get a dashboard list Fetch an existing dashboard list's definition.","title":"get_dashboard_list"},{"location":"v1/DashboardListsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to fetch. # example passing only required values which don't have defaults set try: # Get a dashboard list api_response = api_instance.get_dashboard_list(list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_2","text":"Name Type Description Notes list_id int ID of the dashboard list to fetch.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_2","text":"DashboardList","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#list_dashboard_lists","text":"DashboardListListResponse list_dashboard_lists() Get all dashboard lists Fetch all of your existing dashboard list definitions.","title":"list_dashboard_lists"},{"location":"v1/DashboardListsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all dashboard lists api_response = api_instance.list_dashboard_lists() pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->list_dashboard_lists: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_3","text":"DashboardListListResponse","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardListsApi/#update_dashboard_list","text":"DashboardList update_dashboard_list(list_id, body) Update a dashboard list Update the name of a dashboard list.","title":"update_dashboard_list"},{"location":"v1/DashboardListsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboard_lists_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) list_id = 1 # int | ID of the dashboard list to update. body = DashboardList( author=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), created=dateutil_parser('1970-01-01T00:00:00.00Z'), dashboard_count=1, id=1, is_favorite=True, modified=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"My Dashboard\", type=\"manual_dashboard_list\", ) # DashboardList | Update a dashboard list request body. # example passing only required values which don't have defaults set try: # Update a dashboard list api_response = api_instance.update_dashboard_list(list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardListsApi/#parameters_4","text":"Name Type Description Notes list_id int ID of the dashboard list to update. body DashboardList Update a dashboard list request body.","title":"Parameters"},{"location":"v1/DashboardListsApi/#return-type_4","text":"DashboardList","title":"Return type"},{"location":"v1/DashboardListsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardListsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardListsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardReflowType/","text":"DashboardReflowType Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. Properties Name Type Description Notes value str Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. must be one of [\"auto\", \"fixed\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardReflowType"},{"location":"v1/DashboardReflowType/#dashboardreflowtype","text":"Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.","title":"DashboardReflowType"},{"location":"v1/DashboardReflowType/#properties","text":"Name Type Description Notes value str Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. must be one of [\"auto\", \"fixed\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardSummary/","text":"DashboardSummary Dashboard summary response. Properties Name Type Description Notes dashboards [DashboardSummaryDefinition] List of dashboard definitions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardSummary"},{"location":"v1/DashboardSummary/#dashboardsummary","text":"Dashboard summary response.","title":"DashboardSummary"},{"location":"v1/DashboardSummary/#properties","text":"Name Type Description Notes dashboards [DashboardSummaryDefinition] List of dashboard definitions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardSummaryDefinition/","text":"DashboardSummaryDefinition Dashboard definition. Properties Name Type Description Notes author_handle str Identifier of the dashboard author. [optional] created_at datetime Creation date of the dashboard. [optional] description str Description of the dashboard. [optional] id str Dashboard identifier. [optional] is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] layout_type DashboardLayoutType [optional] modified_at datetime Modification date of the dashboard. [optional] title str Title of the dashboard. [optional] url str URL of the dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardSummaryDefinition"},{"location":"v1/DashboardSummaryDefinition/#dashboardsummarydefinition","text":"Dashboard definition.","title":"DashboardSummaryDefinition"},{"location":"v1/DashboardSummaryDefinition/#properties","text":"Name Type Description Notes author_handle str Identifier of the dashboard author. [optional] created_at datetime Creation date of the dashboard. [optional] description str Description of the dashboard. [optional] id str Dashboard identifier. [optional] is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] layout_type DashboardLayoutType [optional] modified_at datetime Modification date of the dashboard. [optional] title str Title of the dashboard. [optional] url str URL of the dashboard. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardTemplateVariable/","text":"DashboardTemplateVariable Template variable. Properties Name Type Description Notes name str The name of the variable. default str, none_type The default value for the template variable on dashboard load. [optional] prefix str, none_type The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardTemplateVariable"},{"location":"v1/DashboardTemplateVariable/#dashboardtemplatevariable","text":"Template variable.","title":"DashboardTemplateVariable"},{"location":"v1/DashboardTemplateVariable/#properties","text":"Name Type Description Notes name str The name of the variable. default str, none_type The default value for the template variable on dashboard load. [optional] prefix str, none_type The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardTemplateVariablePreset/","text":"DashboardTemplateVariablePreset Template variables saved views. Properties Name Type Description Notes name str The name of the variable. [optional] template_variables [DashboardTemplateVariablePresetValue] List of variables. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardTemplateVariablePreset"},{"location":"v1/DashboardTemplateVariablePreset/#dashboardtemplatevariablepreset","text":"Template variables saved views.","title":"DashboardTemplateVariablePreset"},{"location":"v1/DashboardTemplateVariablePreset/#properties","text":"Name Type Description Notes name str The name of the variable. [optional] template_variables [DashboardTemplateVariablePresetValue] List of variables. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardTemplateVariablePresetValue/","text":"DashboardTemplateVariablePresetValue Template variables saved views. Properties Name Type Description Notes name str The name of the variable. [optional] value str The value of the template variable within the saved view. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardTemplateVariablePresetValue"},{"location":"v1/DashboardTemplateVariablePresetValue/#dashboardtemplatevariablepresetvalue","text":"Template variables saved views.","title":"DashboardTemplateVariablePresetValue"},{"location":"v1/DashboardTemplateVariablePresetValue/#properties","text":"Name Type Description Notes name str The name of the variable. [optional] value str The value of the template variable within the saved view. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DashboardsApi/","text":"datadog_api_client.v1.DashboardsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard POST /api/v1/dashboard Create a new dashboard delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard list_dashboards GET /api/v1/dashboard Get all dashboards update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard create_dashboard Dashboard create_dashboard(body) Create a new dashboard Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the as_count() or as_rate() modifiers appended. Refer to the following documentation for more information on these modifiers. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Create a dashboard request body. # example passing only required values which don't have defaults set try: # Create a new dashboard api_response = api_instance.create_dashboard(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->create_dashboard: %s\\n\" % e) Parameters Name Type Description Notes body Dashboard Create a dashboard request body. Return type Dashboard Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_dashboard DashboardDeleteResponse delete_dashboard(dashboard_id) Delete a dashboard Delete a dashboard using the specified ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Delete a dashboard api_response = api_instance.delete_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->delete_dashboard: %s\\n\" % e) Parameters Name Type Description Notes dashboard_id str The ID of the dashboard. Return type DashboardDeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - 404 Dashboards Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_dashboard Dashboard get_dashboard(dashboard_id) Get a dashboard Get a dashboard using the specified ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Get a dashboard api_response = api_instance.get_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->get_dashboard: %s\\n\" % e) Parameters Name Type Description Notes dashboard_id str The ID of the dashboard. Return type Dashboard Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_dashboards DashboardSummary list_dashboards() Get all dashboards Get all dashboards. Note : This query will only return custom created or cloned dashboards. This query will not return preset dashboards. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) filter_shared = True # bool | When `true`, this query only returns shared custom created or cloned dashboards. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all dashboards api_response = api_instance.list_dashboards(filter_shared=filter_shared) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->list_dashboards: %s\\n\" % e) Parameters Name Type Description Notes filter_shared bool When `true`, this query only returns shared custom created or cloned dashboards. [optional] Return type DashboardSummary Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_dashboard Dashboard update_dashboard(dashboard_id, body) Update a dashboard Update a dashboard using the specified ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Update Dashboard request body. # example passing only required values which don't have defaults set try: # Update a dashboard api_response = api_instance.update_dashboard(dashboard_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->update_dashboard: %s\\n\" % e) Parameters Name Type Description Notes dashboard_id str The ID of the dashboard. body Dashboard Update Dashboard request body. Return type Dashboard Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.DashboardsApi"},{"location":"v1/DashboardsApi/#datadog_api_clientv1dashboardsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard POST /api/v1/dashboard Create a new dashboard delete_dashboard DELETE /api/v1/dashboard/{dashboard_id} Delete a dashboard get_dashboard GET /api/v1/dashboard/{dashboard_id} Get a dashboard list_dashboards GET /api/v1/dashboard Get all dashboards update_dashboard PUT /api/v1/dashboard/{dashboard_id} Update a dashboard","title":"datadog_api_client.v1.DashboardsApi"},{"location":"v1/DashboardsApi/#create_dashboard","text":"Dashboard create_dashboard(body) Create a new dashboard Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the as_count() or as_rate() modifiers appended. Refer to the following documentation for more information on these modifiers.","title":"create_dashboard"},{"location":"v1/DashboardsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Create a dashboard request body. # example passing only required values which don't have defaults set try: # Create a new dashboard api_response = api_instance.create_dashboard(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->create_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters","text":"Name Type Description Notes body Dashboard Create a dashboard request body.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type","text":"Dashboard","title":"Return type"},{"location":"v1/DashboardsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#delete_dashboard","text":"DashboardDeleteResponse delete_dashboard(dashboard_id) Delete a dashboard Delete a dashboard using the specified ID.","title":"delete_dashboard"},{"location":"v1/DashboardsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Delete a dashboard api_response = api_instance.delete_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->delete_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_1","text":"Name Type Description Notes dashboard_id str The ID of the dashboard.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_1","text":"DashboardDeleteResponse","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Authentication Error - 404 Dashboards Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#get_dashboard","text":"Dashboard get_dashboard(dashboard_id) Get a dashboard Get a dashboard using the specified ID.","title":"get_dashboard"},{"location":"v1/DashboardsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. # example passing only required values which don't have defaults set try: # Get a dashboard api_response = api_instance.get_dashboard(dashboard_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->get_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_2","text":"Name Type Description Notes dashboard_id str The ID of the dashboard.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_2","text":"Dashboard","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#list_dashboards","text":"DashboardSummary list_dashboards() Get all dashboards Get all dashboards. Note : This query will only return custom created or cloned dashboards. This query will not return preset dashboards.","title":"list_dashboards"},{"location":"v1/DashboardsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) filter_shared = True # bool | When `true`, this query only returns shared custom created or cloned dashboards. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all dashboards api_response = api_instance.list_dashboards(filter_shared=filter_shared) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->list_dashboards: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_3","text":"Name Type Description Notes filter_shared bool When `true`, this query only returns shared custom created or cloned dashboards. [optional]","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_3","text":"DashboardSummary","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DashboardsApi/#update_dashboard","text":"Dashboard update_dashboard(dashboard_id, body) Update a dashboard Update a dashboard using the specified ID.","title":"update_dashboard"},{"location":"v1/DashboardsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import dashboards_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboards_api.DashboardsApi(api_client) dashboard_id = \"dashboard_id_example\" # str | The ID of the dashboard. body = Dashboard( author_handle=\"test@datadoghq.com\", created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), description=\"description_example\", id=\"123-abc-456\", is_read_only=False, layout_type=DashboardLayoutType(\"ordered\"), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), notify_list=[ \"notify_list_example\", ], reflow_type=DashboardReflowType(\"auto\"), template_variable_presets=[ DashboardTemplateVariablePreset( name=\"name_example\", template_variables=[ DashboardTemplateVariablePresetValue( name=\"name_example\", value=\"value_example\", ), ], ), ], template_variables=[ DashboardTemplateVariable( default=\"my-host\", name=\"host1\", prefix=\"host\", ), ], title=\"\", url=\"/dashboard/123-abc-456/example-dashboard-title\", widgets=[ Widget( definition=WidgetDefinition(), id=1, layout=WidgetLayout( height=0, is_column_break=False, width=0, x=0, y=0, ), ), ], ) # Dashboard | Update Dashboard request body. # example passing only required values which don't have defaults set try: # Update a dashboard api_response = api_instance.update_dashboard(dashboard_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardsApi->update_dashboard: %s\\n\" % e)","title":"Example"},{"location":"v1/DashboardsApi/#parameters_4","text":"Name Type Description Notes dashboard_id str The ID of the dashboard. body Dashboard Update Dashboard request body.","title":"Parameters"},{"location":"v1/DashboardsApi/#return-type_4","text":"Dashboard","title":"Return type"},{"location":"v1/DashboardsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DashboardsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DashboardsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DeletedMonitor/","text":"DeletedMonitor Response from the delete monitor call. Properties Name Type Description Notes deleted_monitor_id int ID of the deleted monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DeletedMonitor"},{"location":"v1/DeletedMonitor/#deletedmonitor","text":"Response from the delete monitor call.","title":"DeletedMonitor"},{"location":"v1/DeletedMonitor/#properties","text":"Name Type Description Notes deleted_monitor_id int ID of the deleted monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetDefinition/","text":"DistributionWidgetDefinition The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph\u2019s x-axis is quantity rather than time. Properties Name Type Description Notes requests [DistributionWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type DistributionWidgetDefinitionType legend_size str (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis DistributionWidgetXAxis [optional] yaxis DistributionWidgetYAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetDefinition"},{"location":"v1/DistributionWidgetDefinition/#distributionwidgetdefinition","text":"The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph\u2019s x-axis is quantity rather than time.","title":"DistributionWidgetDefinition"},{"location":"v1/DistributionWidgetDefinition/#properties","text":"Name Type Description Notes requests [DistributionWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`. type DistributionWidgetDefinitionType legend_size str (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (Deprecated) The widget legend was replaced by a tooltip and sidebar. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis DistributionWidgetXAxis [optional] yaxis DistributionWidgetYAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetDefinitionType/","text":"DistributionWidgetDefinitionType Type of the distribution widget. Properties Name Type Description Notes value str Type of the distribution widget. defaults to \"distribution\", must be one of [\"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetDefinitionType"},{"location":"v1/DistributionWidgetDefinitionType/#distributionwidgetdefinitiontype","text":"Type of the distribution widget.","title":"DistributionWidgetDefinitionType"},{"location":"v1/DistributionWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the distribution widget. defaults to \"distribution\", must be one of [\"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetRequest/","text":"DistributionWidgetRequest Updated distribution widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetRequest"},{"location":"v1/DistributionWidgetRequest/#distributionwidgetrequest","text":"Updated distribution widget.","title":"DistributionWidgetRequest"},{"location":"v1/DistributionWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetXAxis/","text":"DistributionWidgetXAxis X Axis controls for the distribution widget. Properties Name Type Description Notes include_zero bool True includes zero. [optional] max str Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetXAxis"},{"location":"v1/DistributionWidgetXAxis/#distributionwidgetxaxis","text":"X Axis controls for the distribution widget.","title":"DistributionWidgetXAxis"},{"location":"v1/DistributionWidgetXAxis/#properties","text":"Name Type Description Notes include_zero bool True includes zero. [optional] max str Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DistributionWidgetYAxis/","text":"DistributionWidgetYAxis Y Axis controls for the distribution widget. Properties Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear` or `log`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"DistributionWidgetYAxis"},{"location":"v1/DistributionWidgetYAxis/#distributionwidgetyaxis","text":"Y Axis controls for the distribution widget.","title":"DistributionWidgetYAxis"},{"location":"v1/DistributionWidgetYAxis/#properties","text":"Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear` or `log`. [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Downtime/","text":"Downtime Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags. Properties Name Type Description Notes active bool If a scheduled downtime currently exists. optional canceled int, none_type If a scheduled downtime is canceled. optional creator_id int User ID of the downtime creator. optional disabled bool If a downtime has been disabled. [optional] downtime_type int `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 end int, none_type POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. [optional] id int The downtime ID. optional message str 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 int, none_type A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. [optional] monitor_tags [str] 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 int, none_type ID of the parent Downtime. [optional] recurrence DowntimeRecurrence [optional] scope [str] 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 int POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. [optional] timezone str The timezone in which to display the downtime's start and end times in Datadog applications. [optional] updater_id int, none_type ID of the last user that updated the downtime. optional [Back to Model list] [Back to API list] [Back to README]","title":"Downtime"},{"location":"v1/Downtime/#downtime","text":"Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.","title":"Downtime"},{"location":"v1/Downtime/#properties","text":"Name Type Description Notes active bool If a scheduled downtime currently exists. optional canceled int, none_type If a scheduled downtime is canceled. optional creator_id int User ID of the downtime creator. optional disabled bool If a downtime has been disabled. [optional] downtime_type int `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 end int, none_type POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. [optional] id int The downtime ID. optional message str 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 int, none_type A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. [optional] monitor_tags [str] 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 int, none_type ID of the parent Downtime. [optional] recurrence DowntimeRecurrence [optional] scope [str] 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 int POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. [optional] timezone str The timezone in which to display the downtime's start and end times in Datadog applications. [optional] updater_id int, none_type ID of the last user that updated the downtime. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DowntimeRecurrence/","text":"DowntimeRecurrence An object defining the recurrence of the downtime. Properties Name Type Description Notes period int 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 str 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 are supported. Note : Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this downtime guide [optional] type str The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. [optional] until_date int, none_type The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. [optional] until_occurrences int, none_type How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. [optional] week_days [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"DowntimeRecurrence"},{"location":"v1/DowntimeRecurrence/#downtimerecurrence","text":"An object defining the recurrence of the downtime.","title":"DowntimeRecurrence"},{"location":"v1/DowntimeRecurrence/#properties","text":"Name Type Description Notes period int 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 str 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 are supported. Note : Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this downtime guide [optional] type str The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. [optional] until_date int, none_type The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. [optional] until_occurrences int, none_type How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. [optional] week_days [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/DowntimesApi/","text":"datadog_api_client.v1.DowntimesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope create_downtime POST /api/v1/downtime Schedule a downtime get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime list_downtimes GET /api/v1/downtime Get all downtimes list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime cancel_downtime cancel_downtime(downtime_id) Cancel a downtime Cancel a downtime. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to cancel. # example passing only required values which don't have defaults set try: # Cancel a downtime api_instance.cancel_downtime(downtime_id) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtime: %s\\n\" % e) Parameters Name Type Description Notes downtime_id int ID of the downtime to cancel. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] cancel_downtimes_by_scope CanceledDowntimesIds cancel_downtimes_by_scope(body) Cancel downtimes by scope Delete all downtimes that match the scope of X . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = CancelDowntimesByScopeRequest( scope=\"host:myserver\", ) # CancelDowntimesByScopeRequest | Scope to cancel downtimes for. # example passing only required values which don't have defaults set try: # Cancel downtimes by scope api_response = api_instance.cancel_downtimes_by_scope(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtimes_by_scope: %s\\n\" % e) Parameters Name Type Description Notes body CancelDowntimesByScopeRequest Scope to cancel downtimes for. Return type CanceledDowntimesIds Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtimes not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_downtime Downtime create_downtime(body) Schedule a downtime Schedule a downtime. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Schedule a downtime request body. # example passing only required values which don't have defaults set try: # Schedule a downtime api_response = api_instance.create_downtime(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->create_downtime: %s\\n\" % e) Parameters Name Type Description Notes body Downtime Schedule a downtime request body. Return type Downtime Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_downtime Downtime get_downtime(downtime_id) Get a downtime Get downtime detail by downtime_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to fetch. # example passing only required values which don't have defaults set try: # Get a downtime api_response = api_instance.get_downtime(downtime_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->get_downtime: %s\\n\" % e) Parameters Name Type Description Notes downtime_id int ID of the downtime to fetch. Return type Downtime Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_downtimes [Downtime] list_downtimes() Get all downtimes Get all scheduled downtimes. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) current_only = True # bool | Only return downtimes that are active when the request is made. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all downtimes api_response = api_instance.list_downtimes(current_only=current_only) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_downtimes: %s\\n\" % e) Parameters Name Type Description Notes current_only bool Only return downtimes that are active when the request is made. [optional] Return type [Downtime] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_monitor_downtimes [Downtime] list_monitor_downtimes(monitor_id) Get all downtimes for a monitor Get all downtimes for the specified monitor Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) monitor_id = 1 # int | The id of the monitor # example passing only required values which don't have defaults set try: # Get all downtimes for a monitor api_response = api_instance.list_monitor_downtimes(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_monitor_downtimes: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The id of the monitor Return type [Downtime] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_downtime Downtime update_downtime(downtime_id, body) Update a downtime Update a single downtime by downtime_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to update. body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Update a downtime request body. # example passing only required values which don't have defaults set try: # Update a downtime api_response = api_instance.update_downtime(downtime_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->update_downtime: %s\\n\" % e) Parameters Name Type Description Notes downtime_id int ID of the downtime to update. body Downtime Update a downtime request body. Return type Downtime Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.DowntimesApi"},{"location":"v1/DowntimesApi/#datadog_api_clientv1downtimesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description cancel_downtime DELETE /api/v1/downtime/{downtime_id} Cancel a downtime cancel_downtimes_by_scope POST /api/v1/downtime/cancel/by_scope Cancel downtimes by scope create_downtime POST /api/v1/downtime Schedule a downtime get_downtime GET /api/v1/downtime/{downtime_id} Get a downtime list_downtimes GET /api/v1/downtime Get all downtimes list_monitor_downtimes GET /api/v1/monitor/{monitor_id}/downtimes Get all downtimes for a monitor update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime","title":"datadog_api_client.v1.DowntimesApi"},{"location":"v1/DowntimesApi/#cancel_downtime","text":"cancel_downtime(downtime_id) Cancel a downtime Cancel a downtime.","title":"cancel_downtime"},{"location":"v1/DowntimesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to cancel. # example passing only required values which don't have defaults set try: # Cancel a downtime api_instance.cancel_downtime(downtime_id) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters","text":"Name Type Description Notes downtime_id int ID of the downtime to cancel.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type","text":"void (empty response body)","title":"Return type"},{"location":"v1/DowntimesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details","text":"Status code Description Response headers 204 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#cancel_downtimes_by_scope","text":"CanceledDowntimesIds cancel_downtimes_by_scope(body) Cancel downtimes by scope Delete all downtimes that match the scope of X .","title":"cancel_downtimes_by_scope"},{"location":"v1/DowntimesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = CancelDowntimesByScopeRequest( scope=\"host:myserver\", ) # CancelDowntimesByScopeRequest | Scope to cancel downtimes for. # example passing only required values which don't have defaults set try: # Cancel downtimes by scope api_response = api_instance.cancel_downtimes_by_scope(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->cancel_downtimes_by_scope: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_1","text":"Name Type Description Notes body CancelDowntimesByScopeRequest Scope to cancel downtimes for.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_1","text":"CanceledDowntimesIds","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtimes not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#create_downtime","text":"Downtime create_downtime(body) Schedule a downtime Schedule a downtime.","title":"create_downtime"},{"location":"v1/DowntimesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Schedule a downtime request body. # example passing only required values which don't have defaults set try: # Schedule a downtime api_response = api_instance.create_downtime(body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->create_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_2","text":"Name Type Description Notes body Downtime Schedule a downtime request body.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_2","text":"Downtime","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#get_downtime","text":"Downtime get_downtime(downtime_id) Get a downtime Get downtime detail by downtime_id .","title":"get_downtime"},{"location":"v1/DowntimesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to fetch. # example passing only required values which don't have defaults set try: # Get a downtime api_response = api_instance.get_downtime(downtime_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->get_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_3","text":"Name Type Description Notes downtime_id int ID of the downtime to fetch.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_3","text":"Downtime","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#list_downtimes","text":"[Downtime] list_downtimes() Get all downtimes Get all scheduled downtimes.","title":"list_downtimes"},{"location":"v1/DowntimesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) current_only = True # bool | Only return downtimes that are active when the request is made. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all downtimes api_response = api_instance.list_downtimes(current_only=current_only) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_downtimes: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_4","text":"Name Type Description Notes current_only bool Only return downtimes that are active when the request is made. [optional]","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_4","text":"[Downtime]","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#list_monitor_downtimes","text":"[Downtime] list_monitor_downtimes(monitor_id) Get all downtimes for a monitor Get all downtimes for the specified monitor","title":"list_monitor_downtimes"},{"location":"v1/DowntimesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) monitor_id = 1 # int | The id of the monitor # example passing only required values which don't have defaults set try: # Get all downtimes for a monitor api_response = api_instance.list_monitor_downtimes(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->list_monitor_downtimes: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_5","text":"Name Type Description Notes monitor_id int The id of the monitor","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_5","text":"[Downtime]","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/DowntimesApi/#update_downtime","text":"Downtime update_downtime(downtime_id, body) Update a downtime Update a single downtime by downtime_id .","title":"update_downtime"},{"location":"v1/DowntimesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import downtimes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = downtimes_api.DowntimesApi(api_client) downtime_id = 123456 # int | ID of the downtime to update. body = Downtime( active=True, canceled=1412799983, creator_id=123456, disabled=False, downtime_type=2, end=1412793983, id=1625, message=\"Message on the downtime\", monitor_id=123456, monitor_tags=[\"*\"], parent_id=123, recurrence=DowntimeRecurrence( period=1, rrule=\"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1\", type=\"weeks\", until_date=1447786293, until_occurrences=2, week_days=[\"Mon\",\"Tue\"], ), scope=[\"env:staging\"], start=1412792983, timezone=\"America/New_York\", updater_id=123456, ) # Downtime | Update a downtime request body. # example passing only required values which don't have defaults set try: # Update a downtime api_response = api_instance.update_downtime(downtime_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DowntimesApi->update_downtime: %s\\n\" % e)","title":"Example"},{"location":"v1/DowntimesApi/#parameters_6","text":"Name Type Description Notes downtime_id int ID of the downtime to update. body Downtime Update a downtime request body.","title":"Parameters"},{"location":"v1/DowntimesApi/#return-type_6","text":"Downtime","title":"Return type"},{"location":"v1/DowntimesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/DowntimesApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/DowntimesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Downtime not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/Event/","text":"Event Object representing an event. Properties Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Event"},{"location":"v1/Event/#event","text":"Object representing an event.","title":"Event"},{"location":"v1/Event/#properties","text":"Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventAlertType/","text":"EventAlertType If an alert event is enabled, set its type. For example, error , warning , info , success , user_update , recommendation , and snapshot . Properties Name Type Description Notes value str If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. must be one of [\"error\", \"warning\", \"info\", \"success\", \"user_update\", \"recommendation\", \"snapshot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventAlertType"},{"location":"v1/EventAlertType/#eventalerttype","text":"If an alert event is enabled, set its type. For example, error , warning , info , success , user_update , recommendation , and snapshot .","title":"EventAlertType"},{"location":"v1/EventAlertType/#properties","text":"Name Type Description Notes value str If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. must be one of [\"error\", \"warning\", \"info\", \"success\", \"user_update\", \"recommendation\", \"snapshot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventCreateRequest/","text":"EventCreateRequest Object representing an event. Properties Name Type Description Notes text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. aggregation_key str 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 [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"EventCreateRequest"},{"location":"v1/EventCreateRequest/#eventcreaterequest","text":"Object representing an event.","title":"EventCreateRequest"},{"location":"v1/EventCreateRequest/#properties","text":"Name Type Description Notes text str 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 str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. aggregation_key str 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 [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] tags [str] A list of tags to apply to the event. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventCreateResponse/","text":"EventCreateResponse Object containing an event response. Properties Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] status str A status. [optional] tags [str] A list of tags to apply to the event. [optional] text str The body of the event. Limited to 4000 characters. The text supports markdown. Use `msg_text` with the Datadog Ruby library. [optional] title str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"EventCreateResponse"},{"location":"v1/EventCreateResponse/#eventcreateresponse","text":"Object containing an event response.","title":"EventCreateResponse"},{"location":"v1/EventCreateResponse/#properties","text":"Name Type Description Notes alert_type EventAlertType [optional] date_happened int 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 str A device name. [optional] host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional] id int Integer ID of the event. optional payload str Payload of the event. optional priority EventPriority [optional] related_event_id int ID of the parent event. Must be sent as an integer (i.e. no quotes). [optional] source_type_name str 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 . [optional] status str A status. [optional] tags [str] A list of tags to apply to the event. [optional] text str The body of the event. Limited to 4000 characters. The text supports markdown. Use `msg_text` with the Datadog Ruby library. [optional] title str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional] url str URL of the event. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventListResponse/","text":"EventListResponse An event list response. Properties Name Type Description Notes events [Event] An array of events. [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventListResponse"},{"location":"v1/EventListResponse/#eventlistresponse","text":"An event list response.","title":"EventListResponse"},{"location":"v1/EventListResponse/#properties","text":"Name Type Description Notes events [Event] An array of events. [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventPriority/","text":"EventPriority The priority of the event. For example, normal or low . Properties Name Type Description Notes value str The priority of the event. For example, `normal` or `low`. must be one of [\"normal\", \"low\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventPriority"},{"location":"v1/EventPriority/#eventpriority","text":"The priority of the event. For example, normal or low .","title":"EventPriority"},{"location":"v1/EventPriority/#properties","text":"Name Type Description Notes value str The priority of the event. For example, `normal` or `low`. must be one of [\"normal\", \"low\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventQueryDefinition/","text":"EventQueryDefinition The event query. Properties Name Type Description Notes search str The query being made on the event. tags_execution str The execution method for multi-value filters. Can be either and or or. [Back to Model list] [Back to API list] [Back to README]","title":"EventQueryDefinition"},{"location":"v1/EventQueryDefinition/#eventquerydefinition","text":"The event query.","title":"EventQueryDefinition"},{"location":"v1/EventQueryDefinition/#properties","text":"Name Type Description Notes search str The query being made on the event. tags_execution str The execution method for multi-value filters. Can be either and or or. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventResponse/","text":"EventResponse Object containing an event response. Properties Name Type Description Notes event Event [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventResponse"},{"location":"v1/EventResponse/#eventresponse","text":"Object containing an event response.","title":"EventResponse"},{"location":"v1/EventResponse/#properties","text":"Name Type Description Notes event Event [optional] status str A status. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventStreamWidgetDefinition/","text":"EventStreamWidgetDefinition The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. Properties Name Type Description Notes query str Query to filter the event stream with. type EventStreamWidgetDefinitionType event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventStreamWidgetDefinition"},{"location":"v1/EventStreamWidgetDefinition/#eventstreamwidgetdefinition","text":"The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.","title":"EventStreamWidgetDefinition"},{"location":"v1/EventStreamWidgetDefinition/#properties","text":"Name Type Description Notes query str Query to filter the event stream with. type EventStreamWidgetDefinitionType event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventStreamWidgetDefinitionType/","text":"EventStreamWidgetDefinitionType Type of the event stream widget. Properties Name Type Description Notes value str Type of the event stream widget. defaults to \"event_stream\", must be one of [\"event_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventStreamWidgetDefinitionType"},{"location":"v1/EventStreamWidgetDefinitionType/#eventstreamwidgetdefinitiontype","text":"Type of the event stream widget.","title":"EventStreamWidgetDefinitionType"},{"location":"v1/EventStreamWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the event stream widget. defaults to \"event_stream\", must be one of [\"event_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventTimelineWidgetDefinition/","text":"EventTimelineWidgetDefinition The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards. Properties Name Type Description Notes query str Query to filter the event timeline with. type EventTimelineWidgetDefinitionType tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"EventTimelineWidgetDefinition"},{"location":"v1/EventTimelineWidgetDefinition/#eventtimelinewidgetdefinition","text":"The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.","title":"EventTimelineWidgetDefinition"},{"location":"v1/EventTimelineWidgetDefinition/#properties","text":"Name Type Description Notes query str Query to filter the event timeline with. type EventTimelineWidgetDefinitionType tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventTimelineWidgetDefinitionType/","text":"EventTimelineWidgetDefinitionType Type of the event timeline widget. Properties Name Type Description Notes value str Type of the event timeline widget. defaults to \"event_timeline\", must be one of [\"event_timeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"EventTimelineWidgetDefinitionType"},{"location":"v1/EventTimelineWidgetDefinitionType/#eventtimelinewidgetdefinitiontype","text":"Type of the event timeline widget.","title":"EventTimelineWidgetDefinitionType"},{"location":"v1/EventTimelineWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the event timeline widget. defaults to \"event_timeline\", must be one of [\"event_timeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/EventsApi/","text":"datadog_api_client.v1.EventsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_event POST /api/v1/events Post an event get_event GET /api/v1/events/{event_id} Get an event list_events GET /api/v1/events Query the event stream create_event EventCreateResponse create_event(body) Post an event This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) body = EventCreateRequest( aggregation_key=\"aggregation_key_example\", alert_type=EventAlertType(\"info\"), date_happened=1, device_name=\"device_name_example\", host=\"host_example\", id=1, payload=\"{}\", priority=EventPriority(\"normal\"), related_event_id=1, source_type_name=\"source_type_name_example\", tags=[\"environment:test\"], text=\"Oh boy!\", title=\"Did you hear the news today?\", url=\"url_example\", ) # EventCreateRequest | Event request object # example passing only required values which don't have defaults set try: # Post an event api_response = api_instance.create_event(body) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->create_event: %s\\n\" % e) Parameters Name Type Description Notes body EventCreateRequest Event request object Return type EventCreateResponse Authorization apiKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 202 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_event EventResponse get_event(event_id) Get an event This endpoint allows you to query for event details. Note : If the event you\u2019re querying contains markdown formatting of any kind, you may see characters such as % , \\\\ , n in your output. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) event_id = 1 # int | The ID of the event. # example passing only required values which don't have defaults set try: # Get an event api_response = api_instance.get_event(event_id) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->get_event: %s\\n\" % e) Parameters Name Type Description Notes event_id int The ID of the event. Return type EventResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_events EventListResponse list_events(start, end) Query the event stream The event stream can be queried and filtered by time, priority, sources and tags. Notes : - If the event you\u2019re querying contains markdown formatting of any kind, 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. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) start = 1 # int | POSIX timestamp. end = 1 # int | POSIX timestamp. priority = EventPriority(\"normal\") # EventPriority | Priority of your events, either `low` or `normal`. (optional) sources = \"sources_example\" # str | A comma separated string of sources. (optional) tags = \"host:host0\" # str | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. (optional) unaggregated = True # bool | 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 = True # bool | 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 = 1 # int | 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) # example passing only required values which don't have defaults set try: # Query the event stream api_response = api_instance.list_events(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Query the event stream api_response = api_instance.list_events(start, end, priority=priority, sources=sources, tags=tags, unaggregated=unaggregated, exclude_aggregate=exclude_aggregate, page=page) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e) Parameters Name Type Description Notes start int POSIX timestamp. end int POSIX timestamp. priority EventPriority Priority of your events, either `low` or `normal`. [optional] sources str A comma separated string of sources. [optional] tags str A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. [optional] unaggregated bool 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 bool 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 int 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 EventListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.EventsApi"},{"location":"v1/EventsApi/#datadog_api_clientv1eventsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_event POST /api/v1/events Post an event get_event GET /api/v1/events/{event_id} Get an event list_events GET /api/v1/events Query the event stream","title":"datadog_api_client.v1.EventsApi"},{"location":"v1/EventsApi/#create_event","text":"EventCreateResponse create_event(body) Post an event This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.","title":"create_event"},{"location":"v1/EventsApi/#example","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) body = EventCreateRequest( aggregation_key=\"aggregation_key_example\", alert_type=EventAlertType(\"info\"), date_happened=1, device_name=\"device_name_example\", host=\"host_example\", id=1, payload=\"{}\", priority=EventPriority(\"normal\"), related_event_id=1, source_type_name=\"source_type_name_example\", tags=[\"environment:test\"], text=\"Oh boy!\", title=\"Did you hear the news today?\", url=\"url_example\", ) # EventCreateRequest | Event request object # example passing only required values which don't have defaults set try: # Post an event api_response = api_instance.create_event(body) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->create_event: %s\\n\" % e)","title":"Example"},{"location":"v1/EventsApi/#parameters","text":"Name Type Description Notes body EventCreateRequest Event request object","title":"Parameters"},{"location":"v1/EventsApi/#return-type","text":"EventCreateResponse","title":"Return type"},{"location":"v1/EventsApi/#authorization","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/EventsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/EventsApi/#http-response-details","text":"Status code Description Response headers 202 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/EventsApi/#get_event","text":"EventResponse get_event(event_id) Get an event This endpoint allows you to query for event details. Note : If the event you\u2019re querying contains markdown formatting of any kind, you may see characters such as % , \\\\ , n in your output.","title":"get_event"},{"location":"v1/EventsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) event_id = 1 # int | The ID of the event. # example passing only required values which don't have defaults set try: # Get an event api_response = api_instance.get_event(event_id) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->get_event: %s\\n\" % e)","title":"Example"},{"location":"v1/EventsApi/#parameters_1","text":"Name Type Description Notes event_id int The ID of the event.","title":"Parameters"},{"location":"v1/EventsApi/#return-type_1","text":"EventResponse","title":"Return type"},{"location":"v1/EventsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/EventsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/EventsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Authentication Error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/EventsApi/#list_events","text":"EventListResponse list_events(start, end) Query the event stream The event stream can be queried and filtered by time, priority, sources and tags. Notes : - If the event you\u2019re querying contains markdown formatting of any kind, 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.","title":"list_events"},{"location":"v1/EventsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import events_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = events_api.EventsApi(api_client) start = 1 # int | POSIX timestamp. end = 1 # int | POSIX timestamp. priority = EventPriority(\"normal\") # EventPriority | Priority of your events, either `low` or `normal`. (optional) sources = \"sources_example\" # str | A comma separated string of sources. (optional) tags = \"host:host0\" # str | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. (optional) unaggregated = True # bool | 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 = True # bool | 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 = 1 # int | 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) # example passing only required values which don't have defaults set try: # Query the event stream api_response = api_instance.list_events(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Query the event stream api_response = api_instance.list_events(start, end, priority=priority, sources=sources, tags=tags, unaggregated=unaggregated, exclude_aggregate=exclude_aggregate, page=page) pprint(api_response) except ApiException as e: print(\"Exception when calling EventsApi->list_events: %s\\n\" % e)","title":"Example"},{"location":"v1/EventsApi/#parameters_2","text":"Name Type Description Notes start int POSIX timestamp. end int POSIX timestamp. priority EventPriority Priority of your events, either `low` or `normal`. [optional] sources str A comma separated string of sources. [optional] tags str A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. [optional] unaggregated bool 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 bool 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 int 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]","title":"Parameters"},{"location":"v1/EventsApi/#return-type_2","text":"EventListResponse","title":"Return type"},{"location":"v1/EventsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/EventsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/EventsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/FormulaAndFunctionEventAggregation/","text":"FormulaAndFunctionEventAggregation Aggregation methods for event platform queries. Properties Name Type Description Notes value str Aggregation methods for event platform queries. must be one of [\"count\", \"cardinality\", \"median\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventAggregation"},{"location":"v1/FormulaAndFunctionEventAggregation/#formulaandfunctioneventaggregation","text":"Aggregation methods for event platform queries.","title":"FormulaAndFunctionEventAggregation"},{"location":"v1/FormulaAndFunctionEventAggregation/#properties","text":"Name Type Description Notes value str Aggregation methods for event platform queries. must be one of [\"count\", \"cardinality\", \"median\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryDefinition/","text":"FormulaAndFunctionEventQueryDefinition A formula and functions events query. Properties Name Type Description Notes compute FormulaAndFunctionEventQueryDefinitionCompute data_source FormulaAndFunctionEventsDataSource name str Name of the query for use in formulas. group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryDefinition"},{"location":"v1/FormulaAndFunctionEventQueryDefinition/#formulaandfunctioneventquerydefinition","text":"A formula and functions events query.","title":"FormulaAndFunctionEventQueryDefinition"},{"location":"v1/FormulaAndFunctionEventQueryDefinition/#properties","text":"Name Type Description Notes compute FormulaAndFunctionEventQueryDefinitionCompute data_source FormulaAndFunctionEventsDataSource name str Name of the query for use in formulas. group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionCompute/","text":"FormulaAndFunctionEventQueryDefinitionCompute Compute options. Properties Name Type Description Notes aggregation FormulaAndFunctionEventAggregation interval int A time interval in milliseconds. [optional] metric str Measurable attribute to compute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryDefinitionCompute"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionCompute/#formulaandfunctioneventquerydefinitioncompute","text":"Compute options.","title":"FormulaAndFunctionEventQueryDefinitionCompute"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionCompute/#properties","text":"Name Type Description Notes aggregation FormulaAndFunctionEventAggregation interval int A time interval in milliseconds. [optional] metric str Measurable attribute to compute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionSearch/","text":"FormulaAndFunctionEventQueryDefinitionSearch Search options. Properties Name Type Description Notes query str Events search string. [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryDefinitionSearch"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionSearch/#formulaandfunctioneventquerydefinitionsearch","text":"Search options.","title":"FormulaAndFunctionEventQueryDefinitionSearch"},{"location":"v1/FormulaAndFunctionEventQueryDefinitionSearch/#properties","text":"Name Type Description Notes query str Events search string. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryGroupBy/","text":"FormulaAndFunctionEventQueryGroupBy List of objects used to group by. Properties Name Type Description Notes facet str Event facet. limit int Number of groups to return. [optional] sort FormulaAndFunctionEventQueryGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryGroupBy"},{"location":"v1/FormulaAndFunctionEventQueryGroupBy/#formulaandfunctioneventquerygroupby","text":"List of objects used to group by.","title":"FormulaAndFunctionEventQueryGroupBy"},{"location":"v1/FormulaAndFunctionEventQueryGroupBy/#properties","text":"Name Type Description Notes facet str Event facet. limit int Number of groups to return. [optional] sort FormulaAndFunctionEventQueryGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventQueryGroupBySort/","text":"FormulaAndFunctionEventQueryGroupBySort Options for sorting group by results. Properties Name Type Description Notes aggregation FormulaAndFunctionEventAggregation metric str Metric used for sorting group by results. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventQueryGroupBySort"},{"location":"v1/FormulaAndFunctionEventQueryGroupBySort/#formulaandfunctioneventquerygroupbysort","text":"Options for sorting group by results.","title":"FormulaAndFunctionEventQueryGroupBySort"},{"location":"v1/FormulaAndFunctionEventQueryGroupBySort/#properties","text":"Name Type Description Notes aggregation FormulaAndFunctionEventAggregation metric str Metric used for sorting group by results. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionEventsDataSource/","text":"FormulaAndFunctionEventsDataSource Data source for event platform-based queries. Properties Name Type Description Notes value str Data source for event platform-based queries. must be one of [\"logs\", \"spans\", \"network\", \"rum\", \"security_signals\", \"profiles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionEventsDataSource"},{"location":"v1/FormulaAndFunctionEventsDataSource/#formulaandfunctioneventsdatasource","text":"Data source for event platform-based queries.","title":"FormulaAndFunctionEventsDataSource"},{"location":"v1/FormulaAndFunctionEventsDataSource/#properties","text":"Name Type Description Notes value str Data source for event platform-based queries. must be one of [\"logs\", \"spans\", \"network\", \"rum\", \"security_signals\", \"profiles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionMetricAggregation/","text":"FormulaAndFunctionMetricAggregation The aggregation methods available for metrics queries. Properties Name Type Description Notes value str The aggregation methods available for metrics queries. must be one of [\"avg\", \"min\", \"max\", \"sum\", \"last\", \"area\", \"l2norm\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionMetricAggregation"},{"location":"v1/FormulaAndFunctionMetricAggregation/#formulaandfunctionmetricaggregation","text":"The aggregation methods available for metrics queries.","title":"FormulaAndFunctionMetricAggregation"},{"location":"v1/FormulaAndFunctionMetricAggregation/#properties","text":"Name Type Description Notes value str The aggregation methods available for metrics queries. must be one of [\"avg\", \"min\", \"max\", \"sum\", \"last\", \"area\", \"l2norm\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionMetricDataSource/","text":"FormulaAndFunctionMetricDataSource Data source for metrics queries. Properties Name Type Description Notes value str Data source for metrics queries. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionMetricDataSource"},{"location":"v1/FormulaAndFunctionMetricDataSource/#formulaandfunctionmetricdatasource","text":"Data source for metrics queries.","title":"FormulaAndFunctionMetricDataSource"},{"location":"v1/FormulaAndFunctionMetricDataSource/#properties","text":"Name Type Description Notes value str Data source for metrics queries. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionMetricQueryDefinition/","text":"FormulaAndFunctionMetricQueryDefinition A formula and functions metrics query. Properties Name Type Description Notes data_source FormulaAndFunctionMetricDataSource name str Name of the query for use in formulas. query str Metrics query definition. aggregator FormulaAndFunctionMetricAggregation [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionMetricQueryDefinition"},{"location":"v1/FormulaAndFunctionMetricQueryDefinition/#formulaandfunctionmetricquerydefinition","text":"A formula and functions metrics query.","title":"FormulaAndFunctionMetricQueryDefinition"},{"location":"v1/FormulaAndFunctionMetricQueryDefinition/#properties","text":"Name Type Description Notes data_source FormulaAndFunctionMetricDataSource name str Name of the query for use in formulas. query str Metrics query definition. aggregator FormulaAndFunctionMetricAggregation [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionProcessQueryDataSource/","text":"FormulaAndFunctionProcessQueryDataSource Data sources that rely on the process backend. Properties Name Type Description Notes value str Data sources that rely on the process backend. must be one of [\"process\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionProcessQueryDataSource"},{"location":"v1/FormulaAndFunctionProcessQueryDataSource/#formulaandfunctionprocessquerydatasource","text":"Data sources that rely on the process backend.","title":"FormulaAndFunctionProcessQueryDataSource"},{"location":"v1/FormulaAndFunctionProcessQueryDataSource/#properties","text":"Name Type Description Notes value str Data sources that rely on the process backend. must be one of [\"process\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionProcessQueryDefinition/","text":"FormulaAndFunctionProcessQueryDefinition Process query using formulas and functions. Properties Name Type Description Notes data_source FormulaAndFunctionProcessQueryDataSource metric str Process metric name. name str Name of query for use in formulas. aggregator FormulaAndFunctionMetricAggregation [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionProcessQueryDefinition"},{"location":"v1/FormulaAndFunctionProcessQueryDefinition/#formulaandfunctionprocessquerydefinition","text":"Process query using formulas and functions.","title":"FormulaAndFunctionProcessQueryDefinition"},{"location":"v1/FormulaAndFunctionProcessQueryDefinition/#properties","text":"Name Type Description Notes data_source FormulaAndFunctionProcessQueryDataSource metric str Process metric name. name str Name of query for use in formulas. aggregator FormulaAndFunctionMetricAggregation [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionQueryDefinition/","text":"FormulaAndFunctionQueryDefinition A formula and function query. Properties Name Type Description Notes aggregator FormulaAndFunctionMetricAggregation [optional] group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] data_source FormulaAndFunctionProcessQueryDataSource [optional] name str Name of query for use in formulas. [optional] query str Metrics query definition. [optional] compute FormulaAndFunctionEventQueryDefinitionCompute [optional] metric str Process metric name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionQueryDefinition"},{"location":"v1/FormulaAndFunctionQueryDefinition/#formulaandfunctionquerydefinition","text":"A formula and function query.","title":"FormulaAndFunctionQueryDefinition"},{"location":"v1/FormulaAndFunctionQueryDefinition/#properties","text":"Name Type Description Notes aggregator FormulaAndFunctionMetricAggregation [optional] group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional] indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional] search FormulaAndFunctionEventQueryDefinitionSearch [optional] is_normalized_cpu bool Whether to normalize the CPU percentages. [optional] limit int Number of hits to return. [optional] sort QuerySortOrder [optional] tag_filters [str] An array of tags to filter by. [optional] text_filter str Text to use as filter. [optional] data_source FormulaAndFunctionProcessQueryDataSource [optional] name str Name of query for use in formulas. [optional] query str Metrics query definition. [optional] compute FormulaAndFunctionEventQueryDefinitionCompute [optional] metric str Process metric name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FormulaAndFunctionResponseFormat/","text":"FormulaAndFunctionResponseFormat Timeseries or Scalar response. This feature is currently in beta. Properties Name Type Description Notes value str Timeseries or Scalar response. This feature is currently in beta. must be one of [\"timeseries\", \"scalar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FormulaAndFunctionResponseFormat"},{"location":"v1/FormulaAndFunctionResponseFormat/#formulaandfunctionresponseformat","text":"Timeseries or Scalar response. This feature is currently in beta.","title":"FormulaAndFunctionResponseFormat"},{"location":"v1/FormulaAndFunctionResponseFormat/#properties","text":"Name Type Description Notes value str Timeseries or Scalar response. This feature is currently in beta. must be one of [\"timeseries\", \"scalar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FreeTextWidgetDefinition/","text":"FreeTextWidgetDefinition Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards. Properties Name Type Description Notes text str Text to display. type FreeTextWidgetDefinitionType color str Color of the text. [optional] font_size str Size of the text. [optional] text_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FreeTextWidgetDefinition"},{"location":"v1/FreeTextWidgetDefinition/#freetextwidgetdefinition","text":"Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.","title":"FreeTextWidgetDefinition"},{"location":"v1/FreeTextWidgetDefinition/#properties","text":"Name Type Description Notes text str Text to display. type FreeTextWidgetDefinitionType color str Color of the text. [optional] font_size str Size of the text. [optional] text_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/FreeTextWidgetDefinitionType/","text":"FreeTextWidgetDefinitionType Type of the free text widget. Properties Name Type Description Notes value str Type of the free text widget. defaults to \"free_text\", must be one of [\"free_text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"FreeTextWidgetDefinitionType"},{"location":"v1/FreeTextWidgetDefinitionType/#freetextwidgetdefinitiontype","text":"Type of the free text widget.","title":"FreeTextWidgetDefinitionType"},{"location":"v1/FreeTextWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the free text widget. defaults to \"free_text\", must be one of [\"free_text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GCPAccount/","text":"GCPAccount Your Google Cloud Platform Account. Properties Name Type Description Notes auth_provider_x509_cert_url str Should be `https://www.googleapis.com/oauth2/v1/certs`. [optional] auth_uri str Should be `https://accounts.google.com/o/oauth2/auth`. [optional] automute bool Silence monitors for expected GCE instance shutdowns. [optional] client_email str Your email found in your JSON service account key. [optional] client_id str Your ID found in your JSON service account key. [optional] client_x509_cert_url str Should be `https://www.googleapis.com/robot/v1/metadata/x509/` where `` is the email found in your JSON service account key. [optional] errors [str] An array of errors. [optional] host_filters str 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 str Your private key name found in your JSON service account key. [optional] private_key_id str Your private key ID found in your JSON service account key. [optional] project_id str Your Google Cloud project ID found in your JSON service account key. [optional] token_uri str Should be `https://accounts.google.com/o/oauth2/token`. [optional] type str The value for service_account found in your JSON service account key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GCPAccount"},{"location":"v1/GCPAccount/#gcpaccount","text":"Your Google Cloud Platform Account.","title":"GCPAccount"},{"location":"v1/GCPAccount/#properties","text":"Name Type Description Notes auth_provider_x509_cert_url str Should be `https://www.googleapis.com/oauth2/v1/certs`. [optional] auth_uri str Should be `https://accounts.google.com/o/oauth2/auth`. [optional] automute bool Silence monitors for expected GCE instance shutdowns. [optional] client_email str Your email found in your JSON service account key. [optional] client_id str Your ID found in your JSON service account key. [optional] client_x509_cert_url str Should be `https://www.googleapis.com/robot/v1/metadata/x509/` where `` is the email found in your JSON service account key. [optional] errors [str] An array of errors. [optional] host_filters str 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 str Your private key name found in your JSON service account key. [optional] private_key_id str Your private key ID found in your JSON service account key. [optional] project_id str Your Google Cloud project ID found in your JSON service account key. [optional] token_uri str Should be `https://accounts.google.com/o/oauth2/token`. [optional] type str The value for service_account found in your JSON service account key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GCPAccountListResponse/","text":"GCPAccountListResponse Array of GCP account responses. Properties Name Type Description Notes value [GCPAccount] Array of GCP account responses. [Back to Model list] [Back to API list] [Back to README]","title":"GCPAccountListResponse"},{"location":"v1/GCPAccountListResponse/#gcpaccountlistresponse","text":"Array of GCP account responses.","title":"GCPAccountListResponse"},{"location":"v1/GCPAccountListResponse/#properties","text":"Name Type Description Notes value [GCPAccount] Array of GCP account responses. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GCPIntegrationApi/","text":"datadog_api_client.v1.GCPIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration create_gcp_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_gcp_integration(body) Create a GCP integration Create a Datadog-GCP integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Create a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Create a GCP integration api_response = api_instance.create_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->create_gcp_integration: %s\\n\" % e) Parameters Name Type Description Notes body GCPAccount Create a Datadog-GCP integration. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_gcp_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_gcp_integration(body) Delete a GCP integration Delete a given Datadog-GCP integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Delete a given Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Delete a GCP integration api_response = api_instance.delete_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->delete_gcp_integration: %s\\n\" % e) Parameters Name Type Description Notes body GCPAccount Delete a given Datadog-GCP integration. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_gcp_integration GCPAccountListResponse list_gcp_integration() List all GCP integrations List all Datadog-GCP integrations configured in your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all GCP integrations api_response = api_instance.list_gcp_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->list_gcp_integration: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type GCPAccountListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_gcp_integration {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_gcp_integration(body) Update a GCP integration Update a Datadog-GCP integrations host_filters and/or auto-mute. Requires a project_id and client_email , however these fields cannot be updated. If you need to update these fields, delete and use the create ( POST ) endpoint. The unspecified fields will keep their original values. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Update a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Update a GCP integration api_response = api_instance.update_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->update_gcp_integration: %s\\n\" % e) Parameters Name Type Description Notes body GCPAccount Update a Datadog-GCP integration. Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.GCPIntegrationApi"},{"location":"v1/GCPIntegrationApi/#datadog_api_clientv1gcpintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_gcp_integration POST /api/v1/integration/gcp Create a GCP integration delete_gcp_integration DELETE /api/v1/integration/gcp Delete a GCP integration list_gcp_integration GET /api/v1/integration/gcp List all GCP integrations update_gcp_integration PUT /api/v1/integration/gcp Update a GCP integration","title":"datadog_api_client.v1.GCPIntegrationApi"},{"location":"v1/GCPIntegrationApi/#create_gcp_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_gcp_integration(body) Create a GCP integration Create a Datadog-GCP integration.","title":"create_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Create a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Create a GCP integration api_response = api_instance.create_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->create_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters","text":"Name Type Description Notes body GCPAccount Create a Datadog-GCP integration.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GCPIntegrationApi/#delete_gcp_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_gcp_integration(body) Delete a GCP integration Delete a given Datadog-GCP integration.","title":"delete_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Delete a given Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Delete a GCP integration api_response = api_instance.delete_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->delete_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters_1","text":"Name Type Description Notes body GCPAccount Delete a given Datadog-GCP integration.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GCPIntegrationApi/#list_gcp_integration","text":"GCPAccountListResponse list_gcp_integration() List all GCP integrations List all Datadog-GCP integrations configured in your Datadog account.","title":"list_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) # example, this endpoint has no required or optional parameters try: # List all GCP integrations api_response = api_instance.list_gcp_integration() pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->list_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type_2","text":"GCPAccountListResponse","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GCPIntegrationApi/#update_gcp_integration","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_gcp_integration(body) Update a GCP integration Update a Datadog-GCP integrations host_filters and/or auto-mute. Requires a project_id and client_email , however these fields cannot be updated. If you need to update these fields, delete and use the create ( POST ) endpoint. The unspecified fields will keep their original values.","title":"update_gcp_integration"},{"location":"v1/GCPIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import gcp_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = gcp_integration_api.GCPIntegrationApi(api_client) body = GCPAccount( auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\", auth_uri=\"https://accounts.google.com/o/oauth2/auth\", automute=True, client_email=\"api-dev@datadog-sandbox.iam.gserviceaccount.com\", client_id=\"123456712345671234567\", client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/\", errors=[\"*\"], host_filters=\"key:value,filter:example\", private_key=\"private_key\", private_key_id=\"123456789abcdefghi123456789abcdefghijklm\", project_id=\"datadog-apitest\", token_uri=\"https://accounts.google.com/o/oauth2/token\", type=\"service_account\", ) # GCPAccount | Update a Datadog-GCP integration. # example passing only required values which don't have defaults set try: # Update a GCP integration api_response = api_instance.update_gcp_integration(body) pprint(api_response) except ApiException as e: print(\"Exception when calling GCPIntegrationApi->update_gcp_integration: %s\\n\" % e)","title":"Example"},{"location":"v1/GCPIntegrationApi/#parameters_3","text":"Name Type Description Notes body GCPAccount Update a Datadog-GCP integration.","title":"Parameters"},{"location":"v1/GCPIntegrationApi/#return-type_3","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/GCPIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/GCPIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/GCPIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/GeomapWidgetDefinition/","text":"GeomapWidgetDefinition This visualization displays a series of values by country on a world map. Properties Name Type Description Notes requests [GeomapWidgetRequest] 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 for information about building the `REQUEST_SCHEMA`. style GeomapWidgetDefinitionStyle type GeomapWidgetDefinitionType view GeomapWidgetDefinitionView custom_links [WidgetCustomLink] A list of custom links. [optional] time WidgetTime [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str The size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinition"},{"location":"v1/GeomapWidgetDefinition/#geomapwidgetdefinition","text":"This visualization displays a series of values by country on a world map.","title":"GeomapWidgetDefinition"},{"location":"v1/GeomapWidgetDefinition/#properties","text":"Name Type Description Notes requests [GeomapWidgetRequest] 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 for information about building the `REQUEST_SCHEMA`. style GeomapWidgetDefinitionStyle type GeomapWidgetDefinitionType view GeomapWidgetDefinitionView custom_links [WidgetCustomLink] A list of custom links. [optional] time WidgetTime [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str The size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetDefinitionStyle/","text":"GeomapWidgetDefinitionStyle The style to apply to the widget. Properties Name Type Description Notes palette str The color palette to apply to the widget. palette_flip bool Whether to flip the palette tones. [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinitionStyle"},{"location":"v1/GeomapWidgetDefinitionStyle/#geomapwidgetdefinitionstyle","text":"The style to apply to the widget.","title":"GeomapWidgetDefinitionStyle"},{"location":"v1/GeomapWidgetDefinitionStyle/#properties","text":"Name Type Description Notes palette str The color palette to apply to the widget. palette_flip bool Whether to flip the palette tones. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetDefinitionType/","text":"GeomapWidgetDefinitionType Type of the geomap widget. Properties Name Type Description Notes value str Type of the geomap widget. defaults to \"geomap\", must be one of [\"geomap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinitionType"},{"location":"v1/GeomapWidgetDefinitionType/#geomapwidgetdefinitiontype","text":"Type of the geomap widget.","title":"GeomapWidgetDefinitionType"},{"location":"v1/GeomapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the geomap widget. defaults to \"geomap\", must be one of [\"geomap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetDefinitionView/","text":"GeomapWidgetDefinitionView The view of the world that the map should render. Properties Name Type Description Notes focus str The 2-letter ISO code of a country to focus the map on. Or `WORLD`. [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetDefinitionView"},{"location":"v1/GeomapWidgetDefinitionView/#geomapwidgetdefinitionview","text":"The view of the world that the map should render.","title":"GeomapWidgetDefinitionView"},{"location":"v1/GeomapWidgetDefinitionView/#properties","text":"Name Type Description Notes focus str The 2-letter ISO code of a country to focus the map on. Or `WORLD`. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GeomapWidgetRequest/","text":"GeomapWidgetRequest An updated geomap widget. Properties Name Type Description Notes formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] q str The widget metrics query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GeomapWidgetRequest"},{"location":"v1/GeomapWidgetRequest/#geomapwidgetrequest","text":"An updated geomap widget.","title":"GeomapWidgetRequest"},{"location":"v1/GeomapWidgetRequest/#properties","text":"Name Type Description Notes formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] q str The widget metrics query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GraphSnapshot/","text":"GraphSnapshot Object representing a graph snapshot. Properties Name Type Description Notes graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] metric_query str The metric query. One of `metric_query` or `graph_def` is required. [optional] snapshot_url str URL of your graph snapshot . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GraphSnapshot"},{"location":"v1/GraphSnapshot/#graphsnapshot","text":"Object representing a graph snapshot.","title":"GraphSnapshot"},{"location":"v1/GraphSnapshot/#properties","text":"Name Type Description Notes graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] metric_query str The metric query. One of `metric_query` or `graph_def` is required. [optional] snapshot_url str URL of your graph snapshot . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GroupWidgetDefinition/","text":"GroupWidgetDefinition The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible. Properties Name Type Description Notes layout_type WidgetLayoutType type GroupWidgetDefinitionType widgets [Widget] List of widget groups. background_color str Background color of the group title. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True title str Title of the widget. [optional] title_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"GroupWidgetDefinition"},{"location":"v1/GroupWidgetDefinition/#groupwidgetdefinition","text":"The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.","title":"GroupWidgetDefinition"},{"location":"v1/GroupWidgetDefinition/#properties","text":"Name Type Description Notes layout_type WidgetLayoutType type GroupWidgetDefinitionType widgets [Widget] List of widget groups. background_color str Background color of the group title. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True title str Title of the widget. [optional] title_align WidgetTextAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/GroupWidgetDefinitionType/","text":"GroupWidgetDefinitionType Type of the group widget. Properties Name Type Description Notes value str Type of the group widget. defaults to \"group\", must be one of [\"group\", ] [Back to Model list] [Back to API list] [Back to README]","title":"GroupWidgetDefinitionType"},{"location":"v1/GroupWidgetDefinitionType/#groupwidgetdefinitiontype","text":"Type of the group widget.","title":"GroupWidgetDefinitionType"},{"location":"v1/GroupWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the group widget. defaults to \"group\", must be one of [\"group\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPLog/","text":"HTTPLog Structured log message. Properties Name Type Description Notes value [HTTPLogItem] Structured log message. [Back to Model list] [Back to API list] [Back to README]","title":"HTTPLog"},{"location":"v1/HTTPLog/#httplog","text":"Structured log message.","title":"HTTPLog"},{"location":"v1/HTTPLog/#properties","text":"Name Type Description Notes value [HTTPLogItem] Structured log message. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPLogError/","text":"HTTPLogError Invalid query performed. Properties Name Type Description Notes code int Error code. message str Error message. [Back to Model list] [Back to API list] [Back to README]","title":"HTTPLogError"},{"location":"v1/HTTPLogError/#httplogerror","text":"Invalid query performed.","title":"HTTPLogError"},{"location":"v1/HTTPLogError/#properties","text":"Name Type Description Notes code int Error code. message str Error message. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPLogItem/","text":"HTTPLogItem Logs that are sent over HTTP. Properties Name Type Description Notes ddsource str 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 . [optional] ddtags str Tags associated with your logs. [optional] hostname str The name of the originating host of the log. [optional] message str The message reserved attribute 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 str 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HTTPLogItem"},{"location":"v1/HTTPLogItem/#httplogitem","text":"Logs that are sent over HTTP.","title":"HTTPLogItem"},{"location":"v1/HTTPLogItem/#properties","text":"Name Type Description Notes ddsource str 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 . [optional] ddtags str Tags associated with your logs. [optional] hostname str The name of the originating host of the log. [optional] message str The message reserved attribute 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 str 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HTTPMethod/","text":"HTTPMethod The HTTP method. Properties Name Type Description Notes value str The HTTP method. must be one of [\"GET\", \"POST\", \"PATCH\", \"PUT\", \"DELETE\", \"HEAD\", \"OPTIONS\", ] [Back to Model list] [Back to API list] [Back to README]","title":"HTTPMethod"},{"location":"v1/HTTPMethod/#httpmethod","text":"The HTTP method.","title":"HTTPMethod"},{"location":"v1/HTTPMethod/#properties","text":"Name Type Description Notes value str The HTTP method. must be one of [\"GET\", \"POST\", \"PATCH\", \"PUT\", \"DELETE\", \"HEAD\", \"OPTIONS\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HeatMapWidgetDefinition/","text":"HeatMapWidgetDefinition The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is. Properties Name Type Description Notes requests [HeatMapWidgetRequest] List of widget types. type HeatMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] show_legend bool Whether or not to display the legend on this widget. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HeatMapWidgetDefinition"},{"location":"v1/HeatMapWidgetDefinition/#heatmapwidgetdefinition","text":"The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.","title":"HeatMapWidgetDefinition"},{"location":"v1/HeatMapWidgetDefinition/#properties","text":"Name Type Description Notes requests [HeatMapWidgetRequest] List of widget types. type HeatMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] show_legend bool Whether or not to display the legend on this widget. [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HeatMapWidgetDefinitionType/","text":"HeatMapWidgetDefinitionType Type of the heat map widget. Properties Name Type Description Notes value str Type of the heat map widget. defaults to \"heatmap\", must be one of [\"heatmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"HeatMapWidgetDefinitionType"},{"location":"v1/HeatMapWidgetDefinitionType/#heatmapwidgetdefinitiontype","text":"Type of the heat map widget.","title":"HeatMapWidgetDefinitionType"},{"location":"v1/HeatMapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the heat map widget. defaults to \"heatmap\", must be one of [\"heatmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HeatMapWidgetRequest/","text":"HeatMapWidgetRequest Updated heat map widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] event_query EventQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HeatMapWidgetRequest"},{"location":"v1/HeatMapWidgetRequest/#heatmapwidgetrequest","text":"Updated heat map widget.","title":"HeatMapWidgetRequest"},{"location":"v1/HeatMapWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] event_query EventQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Host/","text":"Host Object representing a host. Properties Name Type Description Notes aliases [str] Host aliases collected by Datadog. [optional] apps [str] The Datadog integrations reporting metrics for the host. [optional] aws_name str AWS name of your host. [optional] host_name str The host name. [optional] id int The host ID. [optional] is_muted bool If a host is muted or unmuted. [optional] last_reported_time int Last time the host reported a metric data point. [optional] meta HostMeta [optional] metrics HostMetrics [optional] mute_timeout int Timeout of the mute applied to your host. [optional] name str The host name. [optional] sources [str] Source or cloud provider associated with your host. [optional] tags_by_source {str: ([str],)} List of tags for each source (AWS, Datadog Agent, Chef..). [optional] up bool Displays UP when the expected metrics are received and displays `???` if no metrics are received. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Host"},{"location":"v1/Host/#host","text":"Object representing a host.","title":"Host"},{"location":"v1/Host/#properties","text":"Name Type Description Notes aliases [str] Host aliases collected by Datadog. [optional] apps [str] The Datadog integrations reporting metrics for the host. [optional] aws_name str AWS name of your host. [optional] host_name str The host name. [optional] id int The host ID. [optional] is_muted bool If a host is muted or unmuted. [optional] last_reported_time int Last time the host reported a metric data point. [optional] meta HostMeta [optional] metrics HostMetrics [optional] mute_timeout int Timeout of the mute applied to your host. [optional] name str The host name. [optional] sources [str] Source or cloud provider associated with your host. [optional] tags_by_source {str: ([str],)} List of tags for each source (AWS, Datadog Agent, Chef..). [optional] up bool Displays UP when the expected metrics are received and displays `???` if no metrics are received. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostListResponse/","text":"HostListResponse Response with Host information from Datadog. Properties Name Type Description Notes host_list [Host] Array of hosts. [optional] total_matching int Number of host matching the query. [optional] total_returned int Number of host returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostListResponse"},{"location":"v1/HostListResponse/#hostlistresponse","text":"Response with Host information from Datadog.","title":"HostListResponse"},{"location":"v1/HostListResponse/#properties","text":"Name Type Description Notes host_list [Host] Array of hosts. [optional] total_matching int Number of host matching the query. [optional] total_returned int Number of host returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapRequest/","text":"HostMapRequest Updated host map. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapRequest"},{"location":"v1/HostMapRequest/#hostmaprequest","text":"Updated host map.","title":"HostMapRequest"},{"location":"v1/HostMapRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinition/","text":"HostMapWidgetDefinition The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. Properties Name Type Description Notes requests HostMapWidgetDefinitionRequests type HostMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] style HostMapWidgetDefinitionStyle [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinition"},{"location":"v1/HostMapWidgetDefinition/#hostmapwidgetdefinition","text":"The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.","title":"HostMapWidgetDefinition"},{"location":"v1/HostMapWidgetDefinition/#properties","text":"Name Type Description Notes requests HostMapWidgetDefinitionRequests type HostMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] style HostMapWidgetDefinitionStyle [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinitionRequests/","text":"HostMapWidgetDefinitionRequests List of definitions. Properties Name Type Description Notes fill HostMapRequest [optional] size HostMapRequest [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinitionRequests"},{"location":"v1/HostMapWidgetDefinitionRequests/#hostmapwidgetdefinitionrequests","text":"List of definitions.","title":"HostMapWidgetDefinitionRequests"},{"location":"v1/HostMapWidgetDefinitionRequests/#properties","text":"Name Type Description Notes fill HostMapRequest [optional] size HostMapRequest [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinitionStyle/","text":"HostMapWidgetDefinitionStyle The style to apply to the widget. Properties Name Type Description Notes fill_max str Max value to use to color the map. [optional] fill_min str Min value to use to color the map. [optional] palette str Color palette to apply to the widget. [optional] palette_flip bool Whether to flip the palette tones. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinitionStyle"},{"location":"v1/HostMapWidgetDefinitionStyle/#hostmapwidgetdefinitionstyle","text":"The style to apply to the widget.","title":"HostMapWidgetDefinitionStyle"},{"location":"v1/HostMapWidgetDefinitionStyle/#properties","text":"Name Type Description Notes fill_max str Max value to use to color the map. [optional] fill_min str Min value to use to color the map. [optional] palette str Color palette to apply to the widget. [optional] palette_flip bool Whether to flip the palette tones. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMapWidgetDefinitionType/","text":"HostMapWidgetDefinitionType Type of the host map widget. Properties Name Type Description Notes value str Type of the host map widget. defaults to \"hostmap\", must be one of [\"hostmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"HostMapWidgetDefinitionType"},{"location":"v1/HostMapWidgetDefinitionType/#hostmapwidgetdefinitiontype","text":"Type of the host map widget.","title":"HostMapWidgetDefinitionType"},{"location":"v1/HostMapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the host map widget. defaults to \"hostmap\", must be one of [\"hostmap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMeta/","text":"HostMeta Metadata associated with your host. Properties Name Type Description Notes nix_v [str] Array of Unix versions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMeta"},{"location":"v1/HostMeta/#hostmeta","text":"Metadata associated with your host.","title":"HostMeta"},{"location":"v1/HostMeta/#properties","text":"Name Type Description Notes nix_v [str] Array of Unix versions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMetrics/","text":"HostMetrics Host Metrics collected. Properties 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] [Back to Model list] [Back to API list] [Back to README]","title":"HostMetrics"},{"location":"v1/HostMetrics/#hostmetrics","text":"Host Metrics collected.","title":"HostMetrics"},{"location":"v1/HostMetrics/#properties","text":"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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMuteResponse/","text":"HostMuteResponse Response with the list of muted host for your organization. Properties Name Type Description Notes action str Action applied to the hosts. [optional] end int POSIX timestamp in seconds when the host is unmuted. [optional] hostname str The host name. [optional] message str Message associated with the mute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMuteResponse"},{"location":"v1/HostMuteResponse/#hostmuteresponse","text":"Response with the list of muted host for your organization.","title":"HostMuteResponse"},{"location":"v1/HostMuteResponse/#properties","text":"Name Type Description Notes action str Action applied to the hosts. [optional] end int POSIX timestamp in seconds when the host is unmuted. [optional] hostname str The host name. [optional] message str Message associated with the mute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostMuteSettings/","text":"HostMuteSettings Combination of settings to mute a host. Properties Name Type Description Notes end int POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. [optional] message str Message to associate with the muting of this host. [optional] override bool If true and the host is already muted, replaces existing host mute settings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostMuteSettings"},{"location":"v1/HostMuteSettings/#hostmutesettings","text":"Combination of settings to mute a host.","title":"HostMuteSettings"},{"location":"v1/HostMuteSettings/#properties","text":"Name Type Description Notes end int POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. [optional] message str Message to associate with the muting of this host. [optional] override bool If true and the host is already muted, replaces existing host mute settings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostTags/","text":"HostTags Set of tags to associate with your host. Properties Name Type Description Notes host str Your host name. [optional] tags [str] A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostTags"},{"location":"v1/HostTags/#hosttags","text":"Set of tags to associate with your host.","title":"HostTags"},{"location":"v1/HostTags/#properties","text":"Name Type Description Notes host str Your host name. [optional] tags [str] A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostTotals/","text":"HostTotals Total number of host currently monitored by Datadog. Properties Name Type Description Notes total_active int Total number of active host (UP and ???) reporting to Datadog. [optional] total_up int Number of host that are UP and reporting to Datadog. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"HostTotals"},{"location":"v1/HostTotals/#hosttotals","text":"Total number of host currently monitored by Datadog.","title":"HostTotals"},{"location":"v1/HostTotals/#properties","text":"Name Type Description Notes total_active int Total number of active host (UP and ???) reporting to Datadog. [optional] total_up int Number of host that are UP and reporting to Datadog. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/HostsApi/","text":"datadog_api_client.v1.HostsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts list_hosts GET /api/v1/hosts Get all hosts for your organization mute_host POST /api/v1/host/{host_name}/mute Mute a host unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host get_host_totals HostTotals get_host_totals() Get the total number of active hosts This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) _from = 1 # int | Number of seconds from which you want to get total number of active hosts. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the total number of active hosts api_response = api_instance.get_host_totals(_from=_from) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->get_host_totals: %s\\n\" % e) Parameters Name Type Description Notes _from int Number of seconds from which you want to get total number of active hosts. [optional] Return type HostTotals Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_hosts HostListResponse list_hosts() Get all hosts for your organization This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) filter = \"filter_example\" # str | String to filter search results. (optional) sort_field = \"sort_field_example\" # str | Sort hosts by this field. (optional) sort_dir = \"sort_dir_example\" # str | Direction of sort. Options include `asc` and `desc`. (optional) start = 1 # int | Host result to start search from. (optional) count = 1 # int | Number of hosts to return. Max 1000. (optional) _from = 1 # int | Number of seconds since UNIX epoch from which you want to search your hosts. (optional) include_muted_hosts_data = True # bool | Include information on the muted status of hosts and when the mute expires. (optional) include_hosts_metadata = True # bool | Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all hosts for your organization api_response = api_instance.list_hosts(filter=filter, sort_field=sort_field, sort_dir=sort_dir, start=start, count=count, _from=_from, include_muted_hosts_data=include_muted_hosts_data, include_hosts_metadata=include_hosts_metadata) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->list_hosts: %s\\n\" % e) Parameters Name Type Description Notes filter str String to filter search results. [optional] sort_field str Sort hosts by this field. [optional] sort_dir str Direction of sort. Options include `asc` and `desc`. [optional] start int Host result to start search from. [optional] count int Number of hosts to return. Max 1000. [optional] _from int Number of seconds since UNIX epoch from which you want to search your hosts. [optional] include_muted_hosts_data bool Include information on the muted status of hosts and when the mute expires. [optional] include_hosts_metadata bool Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). [optional] Return type HostListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] mute_host HostMuteResponse mute_host(host_name, body) Mute a host Mute a host. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to mute. body = HostMuteSettings( end=1579098130, message=\"Muting this host for a test!\", override=False, ) # HostMuteSettings | Mute a host request body. # example passing only required values which don't have defaults set try: # Mute a host api_response = api_instance.mute_host(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->mute_host: %s\\n\" % e) Parameters Name Type Description Notes host_name str Name of the host to mute. body HostMuteSettings Mute a host request body. Return type HostMuteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] unmute_host HostMuteResponse unmute_host(host_name) Unmute a host Unmutes a host. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to unmute. # example passing only required values which don't have defaults set try: # Unmute a host api_response = api_instance.unmute_host(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->unmute_host: %s\\n\" % e) Parameters Name Type Description Notes host_name str Name of the host to unmute. Return type HostMuteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.HostsApi"},{"location":"v1/HostsApi/#datadog_api_clientv1hostsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_host_totals GET /api/v1/hosts/totals Get the total number of active hosts list_hosts GET /api/v1/hosts Get all hosts for your organization mute_host POST /api/v1/host/{host_name}/mute Mute a host unmute_host POST /api/v1/host/{host_name}/unmute Unmute a host","title":"datadog_api_client.v1.HostsApi"},{"location":"v1/HostsApi/#get_host_totals","text":"HostTotals get_host_totals() Get the total number of active hosts This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.","title":"get_host_totals"},{"location":"v1/HostsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) _from = 1 # int | Number of seconds from which you want to get total number of active hosts. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the total number of active hosts api_response = api_instance.get_host_totals(_from=_from) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->get_host_totals: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters","text":"Name Type Description Notes _from int Number of seconds from which you want to get total number of active hosts. [optional]","title":"Parameters"},{"location":"v1/HostsApi/#return-type","text":"HostTotals","title":"Return type"},{"location":"v1/HostsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/HostsApi/#list_hosts","text":"HostListResponse list_hosts() Get all hosts for your organization This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time.","title":"list_hosts"},{"location":"v1/HostsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) filter = \"filter_example\" # str | String to filter search results. (optional) sort_field = \"sort_field_example\" # str | Sort hosts by this field. (optional) sort_dir = \"sort_dir_example\" # str | Direction of sort. Options include `asc` and `desc`. (optional) start = 1 # int | Host result to start search from. (optional) count = 1 # int | Number of hosts to return. Max 1000. (optional) _from = 1 # int | Number of seconds since UNIX epoch from which you want to search your hosts. (optional) include_muted_hosts_data = True # bool | Include information on the muted status of hosts and when the mute expires. (optional) include_hosts_metadata = True # bool | Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all hosts for your organization api_response = api_instance.list_hosts(filter=filter, sort_field=sort_field, sort_dir=sort_dir, start=start, count=count, _from=_from, include_muted_hosts_data=include_muted_hosts_data, include_hosts_metadata=include_hosts_metadata) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->list_hosts: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters_1","text":"Name Type Description Notes filter str String to filter search results. [optional] sort_field str Sort hosts by this field. [optional] sort_dir str Direction of sort. Options include `asc` and `desc`. [optional] start int Host result to start search from. [optional] count int Number of hosts to return. Max 1000. [optional] _from int Number of seconds since UNIX epoch from which you want to search your hosts. [optional] include_muted_hosts_data bool Include information on the muted status of hosts and when the mute expires. [optional] include_hosts_metadata bool Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). [optional]","title":"Parameters"},{"location":"v1/HostsApi/#return-type_1","text":"HostListResponse","title":"Return type"},{"location":"v1/HostsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/HostsApi/#mute_host","text":"HostMuteResponse mute_host(host_name, body) Mute a host Mute a host.","title":"mute_host"},{"location":"v1/HostsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to mute. body = HostMuteSettings( end=1579098130, message=\"Muting this host for a test!\", override=False, ) # HostMuteSettings | Mute a host request body. # example passing only required values which don't have defaults set try: # Mute a host api_response = api_instance.mute_host(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->mute_host: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters_2","text":"Name Type Description Notes host_name str Name of the host to mute. body HostMuteSettings Mute a host request body.","title":"Parameters"},{"location":"v1/HostsApi/#return-type_2","text":"HostMuteResponse","title":"Return type"},{"location":"v1/HostsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/HostsApi/#unmute_host","text":"HostMuteResponse unmute_host(host_name) Unmute a host Unmutes a host. This endpoint takes no JSON arguments.","title":"unmute_host"},{"location":"v1/HostsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import hosts_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = hosts_api.HostsApi(api_client) host_name = \"host_name_example\" # str | Name of the host to unmute. # example passing only required values which don't have defaults set try: # Unmute a host api_response = api_instance.unmute_host(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling HostsApi->unmute_host: %s\\n\" % e)","title":"Example"},{"location":"v1/HostsApi/#parameters_3","text":"Name Type Description Notes host_name str Name of the host to unmute.","title":"Parameters"},{"location":"v1/HostsApi/#return-type_3","text":"HostMuteResponse","title":"Return type"},{"location":"v1/HostsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/HostsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/HostsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/IFrameWidgetDefinition/","text":"IFrameWidgetDefinition The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards. Properties Name Type Description Notes type IFrameWidgetDefinitionType url str URL of the iframe. [Back to Model list] [Back to API list] [Back to README]","title":"IFrameWidgetDefinition"},{"location":"v1/IFrameWidgetDefinition/#iframewidgetdefinition","text":"The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.","title":"IFrameWidgetDefinition"},{"location":"v1/IFrameWidgetDefinition/#properties","text":"Name Type Description Notes type IFrameWidgetDefinitionType url str URL of the iframe. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IFrameWidgetDefinitionType/","text":"IFrameWidgetDefinitionType Type of the iframe widget. Properties Name Type Description Notes value str Type of the iframe widget. defaults to \"iframe\", must be one of [\"iframe\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IFrameWidgetDefinitionType"},{"location":"v1/IFrameWidgetDefinitionType/#iframewidgetdefinitiontype","text":"Type of the iframe widget.","title":"IFrameWidgetDefinitionType"},{"location":"v1/IFrameWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the iframe widget. defaults to \"iframe\", must be one of [\"iframe\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesAPI/","text":"IPPrefixesAPI Available prefix information for the API endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesAPI"},{"location":"v1/IPPrefixesAPI/#ipprefixesapi","text":"Available prefix information for the API endpoints.","title":"IPPrefixesAPI"},{"location":"v1/IPPrefixesAPI/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesAPM/","text":"IPPrefixesAPM Available prefix information for the APM endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesAPM"},{"location":"v1/IPPrefixesAPM/#ipprefixesapm","text":"Available prefix information for the APM endpoints.","title":"IPPrefixesAPM"},{"location":"v1/IPPrefixesAPM/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesAgents/","text":"IPPrefixesAgents Available prefix information for the Agent endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesAgents"},{"location":"v1/IPPrefixesAgents/#ipprefixesagents","text":"Available prefix information for the Agent endpoints.","title":"IPPrefixesAgents"},{"location":"v1/IPPrefixesAgents/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesLogs/","text":"IPPrefixesLogs Available prefix information for the Logs endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesLogs"},{"location":"v1/IPPrefixesLogs/#ipprefixeslogs","text":"Available prefix information for the Logs endpoints.","title":"IPPrefixesLogs"},{"location":"v1/IPPrefixesLogs/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesProcess/","text":"IPPrefixesProcess Available prefix information for the Process endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesProcess"},{"location":"v1/IPPrefixesProcess/#ipprefixesprocess","text":"Available prefix information for the Process endpoints.","title":"IPPrefixesProcess"},{"location":"v1/IPPrefixesProcess/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesSynthetics/","text":"IPPrefixesSynthetics Available prefix information for the Synthetics endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv4_by_location {str: ([str],)} List of IPv4 prefixes by location. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] prefixes_ipv6_by_location {str: ([str],)} List of IPv6 prefixes by location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesSynthetics"},{"location":"v1/IPPrefixesSynthetics/#ipprefixessynthetics","text":"Available prefix information for the Synthetics endpoints.","title":"IPPrefixesSynthetics"},{"location":"v1/IPPrefixesSynthetics/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv4_by_location {str: ([str],)} List of IPv4 prefixes by location. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] prefixes_ipv6_by_location {str: ([str],)} List of IPv6 prefixes by location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPPrefixesWebhooks/","text":"IPPrefixesWebhooks Available prefix information for the Webhook endpoints. Properties Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPPrefixesWebhooks"},{"location":"v1/IPPrefixesWebhooks/#ipprefixeswebhooks","text":"Available prefix information for the Webhook endpoints.","title":"IPPrefixesWebhooks"},{"location":"v1/IPPrefixesWebhooks/#properties","text":"Name Type Description Notes prefixes_ipv4 [str] List of IPv4 prefixes. [optional] prefixes_ipv6 [str] List of IPv6 prefixes. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPRanges/","text":"IPRanges IP ranges. Properties Name Type Description Notes agents IPPrefixesAgents [optional] api IPPrefixesAPI [optional] apm IPPrefixesAPM [optional] logs IPPrefixesLogs [optional] modified str Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. [optional] process IPPrefixesProcess [optional] synthetics IPPrefixesSynthetics [optional] version int Version of the IP list. [optional] webhooks IPPrefixesWebhooks [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IPRanges"},{"location":"v1/IPRanges/#ipranges","text":"IP ranges.","title":"IPRanges"},{"location":"v1/IPRanges/#properties","text":"Name Type Description Notes agents IPPrefixesAgents [optional] api IPPrefixesAPI [optional] apm IPPrefixesAPM [optional] logs IPPrefixesLogs [optional] modified str Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. [optional] process IPPrefixesProcess [optional] synthetics IPPrefixesSynthetics [optional] version int Version of the IP list. [optional] webhooks IPPrefixesWebhooks [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IPRangesApi/","text":"datadog_api_client.v1.IPRangesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_ip_ranges GET / List IP Ranges get_ip_ranges IPRanges get_ip_ranges() List IP Ranges Get information about Datadog IP ranges. Example import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import ip_ranges_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient() as api_client: # Create an instance of the API class api_instance = ip_ranges_api.IPRangesApi(api_client) # example, this endpoint has no required or optional parameters try: # List IP Ranges api_response = api_instance.get_ip_ranges() pprint(api_response) except ApiException as e: print(\"Exception when calling IPRangesApi->get_ip_ranges: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type IPRanges Authorization No authorization required HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.IPRangesApi"},{"location":"v1/IPRangesApi/#datadog_api_clientv1iprangesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_ip_ranges GET / List IP Ranges","title":"datadog_api_client.v1.IPRangesApi"},{"location":"v1/IPRangesApi/#get_ip_ranges","text":"IPRanges get_ip_ranges() List IP Ranges Get information about Datadog IP ranges.","title":"get_ip_ranges"},{"location":"v1/IPRangesApi/#example","text":"import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import ip_ranges_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient() as api_client: # Create an instance of the API class api_instance = ip_ranges_api.IPRangesApi(api_client) # example, this endpoint has no required or optional parameters try: # List IP Ranges api_response = api_instance.get_ip_ranges() pprint(api_response) except ApiException as e: print(\"Exception when calling IPRangesApi->get_ip_ranges: %s\\n\" % e)","title":"Example"},{"location":"v1/IPRangesApi/#parameters","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/IPRangesApi/#return-type","text":"IPRanges","title":"Return type"},{"location":"v1/IPRangesApi/#authorization","text":"No authorization required","title":"Authorization"},{"location":"v1/IPRangesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/IPRangesApi/#http-response-details","text":"Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/IdpFormData/","text":"IdpFormData Object describing the IdP configuration. Properties Name Type Description Notes idp_file file_type The path to the XML metadata file you wish to upload. [Back to Model list] [Back to API list] [Back to README]","title":"IdpFormData"},{"location":"v1/IdpFormData/#idpformdata","text":"Object describing the IdP configuration.","title":"IdpFormData"},{"location":"v1/IdpFormData/#properties","text":"Name Type Description Notes idp_file file_type The path to the XML metadata file you wish to upload. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IdpResponse/","text":"IdpResponse The IdP response object. Properties Name Type Description Notes message str Identity provider response. [Back to Model list] [Back to API list] [Back to README]","title":"IdpResponse"},{"location":"v1/IdpResponse/#idpresponse","text":"The IdP response object.","title":"IdpResponse"},{"location":"v1/IdpResponse/#properties","text":"Name Type Description Notes message str Identity provider response. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ImageWidgetDefinition/","text":"ImageWidgetDefinition The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards. Properties Name Type Description Notes type ImageWidgetDefinitionType url str URL of the image. has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ImageWidgetDefinition"},{"location":"v1/ImageWidgetDefinition/#imagewidgetdefinition","text":"The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.","title":"ImageWidgetDefinition"},{"location":"v1/ImageWidgetDefinition/#properties","text":"Name Type Description Notes type ImageWidgetDefinitionType url str URL of the image. has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ImageWidgetDefinitionType/","text":"ImageWidgetDefinitionType Type of the image widget. Properties Name Type Description Notes value str Type of the image widget. defaults to \"image\", must be one of [\"image\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ImageWidgetDefinitionType"},{"location":"v1/ImageWidgetDefinitionType/#imagewidgetdefinitiontype","text":"Type of the image widget.","title":"ImageWidgetDefinitionType"},{"location":"v1/ImageWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the image widget. defaults to \"image\", must be one of [\"image\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/IntakePayloadAccepted/","text":"IntakePayloadAccepted The payload accepted for intake. Properties Name Type Description Notes status str The status of the intake payload. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IntakePayloadAccepted"},{"location":"v1/IntakePayloadAccepted/#intakepayloadaccepted","text":"The payload accepted for intake.","title":"IntakePayloadAccepted"},{"location":"v1/IntakePayloadAccepted/#properties","text":"Name Type Description Notes status str The status of the intake payload. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/KeyManagementApi/","text":"datadog_api_client.v1.KeyManagementApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v1/api_key Create an API key create_application_key POST /api/v1/application_key Create an application key delete_api_key DELETE /api/v1/api_key/{key} Delete an API key delete_application_key DELETE /api/v1/application_key/{key} Delete an application key get_api_key GET /api/v1/api_key/{key} Get API key get_application_key GET /api/v1/application_key/{key} Get an application key list_api_keys GET /api/v1/api_key Get all API keys list_application_keys GET /api/v1/application_key Get all application keys update_api_key PUT /api/v1/api_key/{key} Edit an API key update_application_key PUT /api/v1/application_key/{key} Edit an application key create_api_key ApiKeyResponse create_api_key(body) Create an API key Creates an API key with a given name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e) Parameters Name Type Description Notes body ApiKey Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_application_key ApplicationKeyResponse create_application_key(body) Create an application key Create an application key with a given name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Create an application key api_response = api_instance.create_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_application_key: %s\\n\" % e) Parameters Name Type Description Notes body ApplicationKey Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_api_key ApiKeyResponse delete_api_key(key) Delete an API key Delete a given API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Delete an API key api_response = api_instance.delete_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific API key you are working with. Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_application_key ApplicationKeyResponse delete_application_key(key) Delete an application key Delete a given application key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Delete an application key api_response = api_instance.delete_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific APP key you are working with. Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_key ApiKeyResponse get_api_key(key) Get API key Get a given API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific API key you are working with. Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_application_key ApplicationKeyResponse get_application_key(key) Get an application key Get a given application key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Get an application key api_response = api_instance.get_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_application_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific APP key you are working with. Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_api_keys ApiKeyListResponse list_api_keys() Get all API keys Get all API keys available for your account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all API keys api_response = api_instance.list_api_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type ApiKeyListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_application_keys ApplicationKeyListResponse list_application_keys() Get all application keys Get all application keys available for your Datadog account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all application keys api_response = api_instance.list_application_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type ApplicationKeyListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_api_key ApiKeyResponse update_api_key(key, body) Edit an API key Edit an API key name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific API key you are working with. body ApiKey Return type ApiKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_application_key ApplicationKeyResponse update_application_key(key, body) Edit an application key Edit an application key name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e) Parameters Name Type Description Notes key str The specific APP key you are working with. body ApplicationKey Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.KeyManagementApi"},{"location":"v1/KeyManagementApi/#datadog_api_clientv1keymanagementapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v1/api_key Create an API key create_application_key POST /api/v1/application_key Create an application key delete_api_key DELETE /api/v1/api_key/{key} Delete an API key delete_application_key DELETE /api/v1/application_key/{key} Delete an application key get_api_key GET /api/v1/api_key/{key} Get API key get_application_key GET /api/v1/application_key/{key} Get an application key list_api_keys GET /api/v1/api_key Get all API keys list_application_keys GET /api/v1/application_key Get all application keys update_api_key PUT /api/v1/api_key/{key} Edit an API key update_application_key PUT /api/v1/application_key/{key} Edit an application key","title":"datadog_api_client.v1.KeyManagementApi"},{"location":"v1/KeyManagementApi/#create_api_key","text":"ApiKeyResponse create_api_key(body) Create an API key Creates an API key with a given name.","title":"create_api_key"},{"location":"v1/KeyManagementApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters","text":"Name Type Description Notes body ApiKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#create_application_key","text":"ApplicationKeyResponse create_application_key(body) Create an application key Create an application key with a given name.","title":"create_application_key"},{"location":"v1/KeyManagementApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Create an application key api_response = api_instance.create_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_1","text":"Name Type Description Notes body ApplicationKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_1","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#delete_api_key","text":"ApiKeyResponse delete_api_key(key) Delete an API key Delete a given API key.","title":"delete_api_key"},{"location":"v1/KeyManagementApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Delete an API key api_response = api_instance.delete_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_2","text":"Name Type Description Notes key str The specific API key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_2","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#delete_application_key","text":"ApplicationKeyResponse delete_application_key(key) Delete an application key Delete a given application key.","title":"delete_application_key"},{"location":"v1/KeyManagementApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Delete an application key api_response = api_instance.delete_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_3","text":"Name Type Description Notes key str The specific APP key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_3","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#get_api_key","text":"ApiKeyResponse get_api_key(key) Get API key Get a given API key.","title":"get_api_key"},{"location":"v1/KeyManagementApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_4","text":"Name Type Description Notes key str The specific API key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_4","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#get_application_key","text":"ApplicationKeyResponse get_application_key(key) Get an application key Get a given application key.","title":"get_application_key"},{"location":"v1/KeyManagementApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. # example passing only required values which don't have defaults set try: # Get an application key api_response = api_instance.get_application_key(key) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_5","text":"Name Type Description Notes key str The specific APP key you are working with.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_5","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#list_api_keys","text":"ApiKeyListResponse list_api_keys() Get all API keys Get all API keys available for your account.","title":"list_api_keys"},{"location":"v1/KeyManagementApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all API keys api_response = api_instance.list_api_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_6","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_6","text":"ApiKeyListResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#list_application_keys","text":"ApplicationKeyListResponse list_application_keys() Get all application keys Get all application keys available for your Datadog account.","title":"list_application_keys"},{"location":"v1/KeyManagementApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all application keys api_response = api_instance.list_application_keys() pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_7","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_7","text":"ApplicationKeyListResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#update_api_key","text":"ApiKeyResponse update_api_key(key, body) Edit an API key Edit an API key name.","title":"update_api_key"},{"location":"v1/KeyManagementApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific API key you are working with. body = ApiKey( created=\"2019-08-02 15:31:07\", created_by=\"john@example.com\", key=\"1234512345123456abcabc912349abcd\", name=\"example user\", ) # ApiKey | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_8","text":"Name Type Description Notes key str The specific API key you are working with. body ApiKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_8","text":"ApiKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/KeyManagementApi/#update_application_key","text":"ApplicationKeyResponse update_application_key(key, body) Edit an application key Edit an application key name.","title":"update_application_key"},{"location":"v1/KeyManagementApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import key_management_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) key = \"key_example\" # str | The specific APP key you are working with. body = ApplicationKey( hash=\"1234512345123459cda4eb9ced49a3d84fd0138c\", name=\"example user\", owner=\"example.com\", ) # ApplicationKey | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(key, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e)","title":"Example"},{"location":"v1/KeyManagementApi/#parameters_9","text":"Name Type Description Notes key str The specific APP key you are working with. body ApplicationKey","title":"Parameters"},{"location":"v1/KeyManagementApi/#return-type_9","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v1/KeyManagementApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/KeyManagementApi/#http-request-headers_9","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/KeyManagementApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/Log/","text":"Log Object describing a log after being processed and stored by Datadog. Properties Name Type Description Notes content LogContent [optional] id str Unique ID of the Log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Log"},{"location":"v1/Log/#log","text":"Object describing a log after being processed and stored by Datadog.","title":"Log"},{"location":"v1/Log/#properties","text":"Name Type Description Notes content LogContent [optional] id str Unique ID of the Log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogContent/","text":"LogContent JSON object containing all log attributes and their associated values. Properties Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 [bool, date, datetime, dict, float, int, list, str, none_type] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogContent"},{"location":"v1/LogContent/#logcontent","text":"JSON object containing all log attributes and their associated values.","title":"LogContent"},{"location":"v1/LogContent/#properties","text":"Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 [bool, date, datetime, dict, float, int, list, str, none_type] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinition/","text":"LogQueryDefinition The log query. Properties Name Type Description Notes compute LogsQueryCompute [optional] group_by [LogQueryDefinitionGroupBy] List of tag prefixes to group by in the case of a cluster check. [optional] index str A coma separated-list of index names. Use \\\"*\\\" query all indexes at once. Multiple Indexes [optional] multi_compute [LogsQueryCompute] This field is mutually exclusive with `compute`. [optional] search LogQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinition"},{"location":"v1/LogQueryDefinition/#logquerydefinition","text":"The log query.","title":"LogQueryDefinition"},{"location":"v1/LogQueryDefinition/#properties","text":"Name Type Description Notes compute LogsQueryCompute [optional] group_by [LogQueryDefinitionGroupBy] List of tag prefixes to group by in the case of a cluster check. [optional] index str A coma separated-list of index names. Use \\\"*\\\" query all indexes at once. Multiple Indexes [optional] multi_compute [LogsQueryCompute] This field is mutually exclusive with `compute`. [optional] search LogQueryDefinitionSearch [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinitionGroupBy/","text":"LogQueryDefinitionGroupBy Defined items in the group. Properties Name Type Description Notes facet str Facet name. limit int Maximum number of items in the group. [optional] sort LogQueryDefinitionGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinitionGroupBy"},{"location":"v1/LogQueryDefinitionGroupBy/#logquerydefinitiongroupby","text":"Defined items in the group.","title":"LogQueryDefinitionGroupBy"},{"location":"v1/LogQueryDefinitionGroupBy/#properties","text":"Name Type Description Notes facet str Facet name. limit int Maximum number of items in the group. [optional] sort LogQueryDefinitionGroupBySort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinitionGroupBySort/","text":"LogQueryDefinitionGroupBySort Define a sorting method. Properties Name Type Description Notes aggregation str The aggregation method. order WidgetSort facet str Facet name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinitionGroupBySort"},{"location":"v1/LogQueryDefinitionGroupBySort/#logquerydefinitiongroupbysort","text":"Define a sorting method.","title":"LogQueryDefinitionGroupBySort"},{"location":"v1/LogQueryDefinitionGroupBySort/#properties","text":"Name Type Description Notes aggregation str The aggregation method. order WidgetSort facet str Facet name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogQueryDefinitionSearch/","text":"LogQueryDefinitionSearch The query being made on the logs. Properties Name Type Description Notes query str Search value to apply. [Back to Model list] [Back to API list] [Back to README]","title":"LogQueryDefinitionSearch"},{"location":"v1/LogQueryDefinitionSearch/#logquerydefinitionsearch","text":"The query being made on the logs.","title":"LogQueryDefinitionSearch"},{"location":"v1/LogQueryDefinitionSearch/#properties","text":"Name Type Description Notes query str Search value to apply. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogStreamWidgetDefinition/","text":"LogStreamWidgetDefinition The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards. Properties Name Type Description Notes type LogStreamWidgetDefinitionType columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] query str Query to filter the log stream with. [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetFieldSort [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogStreamWidgetDefinition"},{"location":"v1/LogStreamWidgetDefinition/#logstreamwidgetdefinition","text":"The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.","title":"LogStreamWidgetDefinition"},{"location":"v1/LogStreamWidgetDefinition/#properties","text":"Name Type Description Notes type LogStreamWidgetDefinitionType columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] query str Query to filter the log stream with. [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetFieldSort [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogStreamWidgetDefinitionType/","text":"LogStreamWidgetDefinitionType Type of the log stream widget. Properties Name Type Description Notes value str Type of the log stream widget. defaults to \"log_stream\", must be one of [\"log_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogStreamWidgetDefinitionType"},{"location":"v1/LogStreamWidgetDefinitionType/#logstreamwidgetdefinitiontype","text":"Type of the log stream widget.","title":"LogStreamWidgetDefinitionType"},{"location":"v1/LogStreamWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the log stream widget. defaults to \"log_stream\", must be one of [\"log_stream\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAPIError/","text":"LogsAPIError Error returned by the Logs API Properties Name Type Description Notes code str Code identifying the error [optional] details [LogsAPIError] Additional error details [optional] message str Error message [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAPIError"},{"location":"v1/LogsAPIError/#logsapierror","text":"Error returned by the Logs API","title":"LogsAPIError"},{"location":"v1/LogsAPIError/#properties","text":"Name Type Description Notes code str Code identifying the error [optional] details [LogsAPIError] Additional error details [optional] message str Error message [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAPIErrorResponse/","text":"LogsAPIErrorResponse Response returned by the Logs API when errors occur. Properties Name Type Description Notes error LogsAPIError [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAPIErrorResponse"},{"location":"v1/LogsAPIErrorResponse/#logsapierrorresponse","text":"Response returned by the Logs API when errors occur.","title":"LogsAPIErrorResponse"},{"location":"v1/LogsAPIErrorResponse/#properties","text":"Name Type Description Notes error LogsAPIError [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsApi/","text":"datadog_api_client.v1.LogsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_logs POST /api/v1/logs-queries/list Search logs submit_log POST /v1/input Send logs list_logs LogsListResponse list_logs(body) Search logs List endpoint returns logs that match a log search query. Results are paginated . If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( index=\"retention-3,retention-15\", limit=1, query=\"service:web* AND @http.status_code:[200 TO 299]\", sort=LogsSort(\"asc\"), start_at=\"start_at_example\", time=LogsListRequestTime( _from=dateutil_parser('2020-02-02T02:02:02Z'), timezone=\"timezone_example\", to=dateutil_parser('2020-02-02T20:20:20Z'), ), ) # LogsListRequest | Logs filter # example passing only required values which don't have defaults set try: # Search logs api_response = api_instance.list_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e) Parameters Name Type Description Notes body LogsListRequest Logs filter Return type LogsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] submit_log {str: (bool, date, datetime, dict, float, int, list, str, none_type)} submit_log(body) Send logs Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - 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. 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) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = HTTPLog([ HTTPLogItem( ddsource=\"nginx\", ddtags=\"env:staging,version:5.1\", hostname=\"i-012345678\", message=\"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\", service=\"payment\", ), ]) # HTTPLog | Log to send (JSON format). content_encoding = ContentEncoding(\"gzip\") # ContentEncoding | HTTP header used to compress the media-type. (optional) ddtags = \"env:prod,user:my-user\" # str | Log tags can be passed as query parameters with `text/plain` content type. (optional) # example passing only required values which don't have defaults set try: # Send logs api_response = api_instance.submit_log(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Send logs api_response = api_instance.submit_log(body, content_encoding=content_encoding, ddtags=ddtags) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e) Parameters Name Type Description Notes body HTTPLog Log to send (JSON format). content_encoding ContentEncoding HTTP header used to compress the media-type. [optional] ddtags str Log tags can be passed as query parameters with `text/plain` content type. [optional] Return type {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Authorization apiKeyAuth HTTP request headers Content-Type : application/json, application/logplex-1, text/plain Accept : application/json HTTP response details Status code Description Response headers 200 Response from server (always 200 empty JSON). - 400 unexpected error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.LogsApi"},{"location":"v1/LogsApi/#datadog_api_clientv1logsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_logs POST /api/v1/logs-queries/list Search logs submit_log POST /v1/input Send logs","title":"datadog_api_client.v1.LogsApi"},{"location":"v1/LogsApi/#list_logs","text":"LogsListResponse list_logs(body) Search logs List endpoint returns logs that match a log search query. Results are paginated . If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives","title":"list_logs"},{"location":"v1/LogsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( index=\"retention-3,retention-15\", limit=1, query=\"service:web* AND @http.status_code:[200 TO 299]\", sort=LogsSort(\"asc\"), start_at=\"start_at_example\", time=LogsListRequestTime( _from=dateutil_parser('2020-02-02T02:02:02Z'), timezone=\"timezone_example\", to=dateutil_parser('2020-02-02T20:20:20Z'), ), ) # LogsListRequest | Logs filter # example passing only required values which don't have defaults set try: # Search logs api_response = api_instance.list_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsApi/#parameters","text":"Name Type Description Notes body LogsListRequest Logs filter","title":"Parameters"},{"location":"v1/LogsApi/#return-type","text":"LogsListResponse","title":"Return type"},{"location":"v1/LogsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsApi/#submit_log","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)} submit_log(body) Send logs Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - 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. 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) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time","title":"submit_log"},{"location":"v1/LogsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = HTTPLog([ HTTPLogItem( ddsource=\"nginx\", ddtags=\"env:staging,version:5.1\", hostname=\"i-012345678\", message=\"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World\", service=\"payment\", ), ]) # HTTPLog | Log to send (JSON format). content_encoding = ContentEncoding(\"gzip\") # ContentEncoding | HTTP header used to compress the media-type. (optional) ddtags = \"env:prod,user:my-user\" # str | Log tags can be passed as query parameters with `text/plain` content type. (optional) # example passing only required values which don't have defaults set try: # Send logs api_response = api_instance.submit_log(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Send logs api_response = api_instance.submit_log(body, content_encoding=content_encoding, ddtags=ddtags) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->submit_log: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsApi/#parameters_1","text":"Name Type Description Notes body HTTPLog Log to send (JSON format). content_encoding ContentEncoding HTTP header used to compress the media-type. [optional] ddtags str Log tags can be passed as query parameters with `text/plain` content type. [optional]","title":"Parameters"},{"location":"v1/LogsApi/#return-type_1","text":"{str: (bool, date, datetime, dict, float, int, list, str, none_type)}","title":"Return type"},{"location":"v1/LogsApi/#authorization_1","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/LogsApi/#http-request-headers_1","text":"Content-Type : application/json, application/logplex-1, text/plain Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsApi/#http-response-details_1","text":"Status code Description Response headers 200 Response from server (always 200 empty JSON). - 400 unexpected error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsArithmeticProcessor/","text":"LogsArithmeticProcessor Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators - , + , * , / . By default, the calculation is skipped if an attribute is missing. Select \u201cReplace missing attribute by 0\u201d to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. Notes : - The operator - needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is 0.1234567891 , the actual value stored for the attribute is 0.123456789 . - If you need to scale a unit of measure, see Scale Filter . Properties Name Type Description Notes expression str Arithmetic operation between one or more log attributes. target str Name of the attribute that contains the result of the arithmetic operation. type LogsArithmeticProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArithmeticProcessor"},{"location":"v1/LogsArithmeticProcessor/#logsarithmeticprocessor","text":"Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators - , + , * , / . By default, the calculation is skipped if an attribute is missing. Select \u201cReplace missing attribute by 0\u201d to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. Notes : - The operator - needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is 0.1234567891 , the actual value stored for the attribute is 0.123456789 . - If you need to scale a unit of measure, see Scale Filter .","title":"LogsArithmeticProcessor"},{"location":"v1/LogsArithmeticProcessor/#properties","text":"Name Type Description Notes expression str Arithmetic operation between one or more log attributes. target str Name of the attribute that contains the result of the arithmetic operation. type LogsArithmeticProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsArithmeticProcessorType/","text":"LogsArithmeticProcessorType Type of logs arithmetic processor. Properties Name Type Description Notes value str Type of logs arithmetic processor. defaults to \"arithmetic-processor\", must be one of [\"arithmetic-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArithmeticProcessorType"},{"location":"v1/LogsArithmeticProcessorType/#logsarithmeticprocessortype","text":"Type of logs arithmetic processor.","title":"LogsArithmeticProcessorType"},{"location":"v1/LogsArithmeticProcessorType/#properties","text":"Name Type Description Notes value str Type of logs arithmetic processor. defaults to \"arithmetic-processor\", must be one of [\"arithmetic-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAttributeRemapper/","text":"LogsAttributeRemapper The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the Tag Best Practice documentation . Some additional constraints are applied as : or , are not allowed in the target tag/attribute name. Properties Name Type Description Notes sources [str] Array of source attributes. target str Final attribute or tag name to remap the sources to. type LogsAttributeRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsAttributeRemapper"},{"location":"v1/LogsAttributeRemapper/#logsattributeremapper","text":"The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the Tag Best Practice documentation . Some additional constraints are applied as : or , are not allowed in the target tag/attribute name.","title":"LogsAttributeRemapper"},{"location":"v1/LogsAttributeRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. target str Final attribute or tag name to remap the sources to. type LogsAttributeRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsAttributeRemapperType/","text":"LogsAttributeRemapperType Type of logs attribute remapper. Properties Name Type Description Notes value str Type of logs attribute remapper. defaults to \"attribute-remapper\", must be one of [\"attribute-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAttributeRemapperType"},{"location":"v1/LogsAttributeRemapperType/#logsattributeremappertype","text":"Type of logs attribute remapper.","title":"LogsAttributeRemapperType"},{"location":"v1/LogsAttributeRemapperType/#properties","text":"Name Type Description Notes value str Type of logs attribute remapper. defaults to \"attribute-remapper\", must be one of [\"attribute-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetention/","text":"LogsByRetention Object containing logs usage data broken down by retention period. Properties Name Type Description Notes orgs LogsByRetentionOrgs [optional] usage [LogsRetentionAggSumUsage] Aggregated index logs usage for each retention period with usage. [optional] usage_by_month LogsByRetentionMonthlyUsage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetention"},{"location":"v1/LogsByRetention/#logsbyretention","text":"Object containing logs usage data broken down by retention period.","title":"LogsByRetention"},{"location":"v1/LogsByRetention/#properties","text":"Name Type Description Notes orgs LogsByRetentionOrgs [optional] usage [LogsRetentionAggSumUsage] Aggregated index logs usage for each retention period with usage. [optional] usage_by_month LogsByRetentionMonthlyUsage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetentionMonthlyUsage/","text":"LogsByRetentionMonthlyUsage Object containing a summary of indexed logs usage by retention period for a single month. Properties Name Type Description Notes date str The month for the usage. [optional] usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the month. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetentionMonthlyUsage"},{"location":"v1/LogsByRetentionMonthlyUsage/#logsbyretentionmonthlyusage","text":"Object containing a summary of indexed logs usage by retention period for a single month.","title":"LogsByRetentionMonthlyUsage"},{"location":"v1/LogsByRetentionMonthlyUsage/#properties","text":"Name Type Description Notes date str The month for the usage. [optional] usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the month. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetentionOrgUsage/","text":"LogsByRetentionOrgUsage Indexed logs usage by retention for a single organization. Properties Name Type Description Notes usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetentionOrgUsage"},{"location":"v1/LogsByRetentionOrgUsage/#logsbyretentionorgusage","text":"Indexed logs usage by retention for a single organization.","title":"LogsByRetentionOrgUsage"},{"location":"v1/LogsByRetentionOrgUsage/#properties","text":"Name Type Description Notes usage [LogsRetentionSumUsage] Indexed logs usage for each active retention for the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsByRetentionOrgs/","text":"LogsByRetentionOrgs Indexed logs usage summary for each organization for each retention period with usage. Properties Name Type Description Notes usage [LogsByRetentionOrgUsage] Indexed logs usage summary for each organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsByRetentionOrgs"},{"location":"v1/LogsByRetentionOrgs/#logsbyretentionorgs","text":"Indexed logs usage summary for each organization for each retention period with usage.","title":"LogsByRetentionOrgs"},{"location":"v1/LogsByRetentionOrgs/#properties","text":"Name Type Description Notes usage [LogsByRetentionOrgUsage] Indexed logs usage summary for each organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsCategoryProcessor/","text":"LogsCategoryProcessor Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes : - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper. Properties Name Type Description Notes categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. target str Name of the target attribute which value is defined by the matching category. type LogsCategoryProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCategoryProcessor"},{"location":"v1/LogsCategoryProcessor/#logscategoryprocessor","text":"Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes : - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper.","title":"LogsCategoryProcessor"},{"location":"v1/LogsCategoryProcessor/#properties","text":"Name Type Description Notes categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. target str Name of the target attribute which value is defined by the matching category. type LogsCategoryProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsCategoryProcessorCategory/","text":"LogsCategoryProcessorCategory Object describing the logs filter. Properties Name Type Description Notes filter LogsFilter [optional] name str Value to assign to the target attribute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCategoryProcessorCategory"},{"location":"v1/LogsCategoryProcessorCategory/#logscategoryprocessorcategory","text":"Object describing the logs filter.","title":"LogsCategoryProcessorCategory"},{"location":"v1/LogsCategoryProcessorCategory/#properties","text":"Name Type Description Notes filter LogsFilter [optional] name str Value to assign to the target attribute. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsCategoryProcessorType/","text":"LogsCategoryProcessorType Type of logs category processor. Properties Name Type Description Notes value str Type of logs category processor. defaults to \"category-processor\", must be one of [\"category-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCategoryProcessorType"},{"location":"v1/LogsCategoryProcessorType/#logscategoryprocessortype","text":"Type of logs category processor.","title":"LogsCategoryProcessorType"},{"location":"v1/LogsCategoryProcessorType/#properties","text":"Name Type Description Notes value str Type of logs category processor. defaults to \"category-processor\", must be one of [\"category-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsDateRemapper/","text":"LogsDateRemapper As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - timestamp - date - _timestamp - Timestamp - eventTime - published_date If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. Note: If your logs don\u2019t contain any of the default attributes and you haven\u2019t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. Properties Name Type Description Notes sources [str] Array of source attributes. type LogsDateRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsDateRemapper"},{"location":"v1/LogsDateRemapper/#logsdateremapper","text":"As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - timestamp - date - _timestamp - Timestamp - eventTime - published_date If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. Note: If your logs don\u2019t contain any of the default attributes and you haven\u2019t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.","title":"LogsDateRemapper"},{"location":"v1/LogsDateRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. type LogsDateRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsDateRemapperType/","text":"LogsDateRemapperType Type of logs date remapper. Properties Name Type Description Notes value str Type of logs date remapper. defaults to \"date-remapper\", must be one of [\"date-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsDateRemapperType"},{"location":"v1/LogsDateRemapperType/#logsdateremappertype","text":"Type of logs date remapper.","title":"LogsDateRemapperType"},{"location":"v1/LogsDateRemapperType/#properties","text":"Name Type Description Notes value str Type of logs date remapper. defaults to \"date-remapper\", must be one of [\"date-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsExclusion/","text":"LogsExclusion Represents the index exclusion filter object from configuration API. Properties Name Type Description Notes name str Name of the index exclusion filter. filter LogsExclusionFilter [optional] is_enabled bool Whether or not the exclusion filter is active. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsExclusion"},{"location":"v1/LogsExclusion/#logsexclusion","text":"Represents the index exclusion filter object from configuration API.","title":"LogsExclusion"},{"location":"v1/LogsExclusion/#properties","text":"Name Type Description Notes name str Name of the index exclusion filter. filter LogsExclusionFilter [optional] is_enabled bool Whether or not the exclusion filter is active. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsExclusionFilter/","text":"LogsExclusionFilter Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle. Properties Name Type Description Notes sample_rate float Sample rate to apply to logs going through this exclusion filter, a value of 1 will exclude all logs matching the query. query str 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsExclusionFilter"},{"location":"v1/LogsExclusionFilter/#logsexclusionfilter","text":"Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.","title":"LogsExclusionFilter"},{"location":"v1/LogsExclusionFilter/#properties","text":"Name Type Description Notes sample_rate float Sample rate to apply to logs going through this exclusion filter, a value of 1 will exclude all logs matching the query. query str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsFilter/","text":"LogsFilter Filter for logs. Properties Name Type Description Notes query str The filter query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsFilter"},{"location":"v1/LogsFilter/#logsfilter","text":"Filter for logs.","title":"LogsFilter"},{"location":"v1/LogsFilter/#properties","text":"Name Type Description Notes query str The filter query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGeoIPParser/","text":"LogsGeoIPParser The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path. Properties Name Type Description Notes type LogsGeoIPParserType sources [str] Array of source attributes. defaults to [\"network.client.ip\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"network.client.geoip\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGeoIPParser"},{"location":"v1/LogsGeoIPParser/#logsgeoipparser","text":"The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path.","title":"LogsGeoIPParser"},{"location":"v1/LogsGeoIPParser/#properties","text":"Name Type Description Notes type LogsGeoIPParserType sources [str] Array of source attributes. defaults to [\"network.client.ip\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"network.client.geoip\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGeoIPParserType/","text":"LogsGeoIPParserType Type of GeoIP parser. Properties Name Type Description Notes value str Type of GeoIP parser. defaults to \"geo-ip-parser\", must be one of [\"geo-ip-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGeoIPParserType"},{"location":"v1/LogsGeoIPParserType/#logsgeoipparsertype","text":"Type of GeoIP parser.","title":"LogsGeoIPParserType"},{"location":"v1/LogsGeoIPParserType/#properties","text":"Name Type Description Notes value str Type of GeoIP parser. defaults to \"geo-ip-parser\", must be one of [\"geo-ip-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGrokParser/","text":"LogsGrokParser Create custom grok rules to parse the full message or a specific attribute of your raw event . For more information, see the parsing section . Properties Name Type Description Notes grok LogsGrokParserRules type LogsGrokParserType source str Name of the log attribute to parse. defaults to \"message\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGrokParser"},{"location":"v1/LogsGrokParser/#logsgrokparser","text":"Create custom grok rules to parse the full message or a specific attribute of your raw event . For more information, see the parsing section .","title":"LogsGrokParser"},{"location":"v1/LogsGrokParser/#properties","text":"Name Type Description Notes grok LogsGrokParserRules type LogsGrokParserType source str Name of the log attribute to parse. defaults to \"message\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGrokParserRules/","text":"LogsGrokParserRules Set of rules for the grok parser. Properties Name Type Description Notes match_rules str List of match rules for the grok parser, separated by a new line. support_rules str List of support rules for the grok parser, separated by a new line. [optional] if omitted the server will use the default value of \"\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsGrokParserRules"},{"location":"v1/LogsGrokParserRules/#logsgrokparserrules","text":"Set of rules for the grok parser.","title":"LogsGrokParserRules"},{"location":"v1/LogsGrokParserRules/#properties","text":"Name Type Description Notes match_rules str List of match rules for the grok parser, separated by a new line. support_rules str List of support rules for the grok parser, separated by a new line. [optional] if omitted the server will use the default value of \"\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsGrokParserType/","text":"LogsGrokParserType Type of logs grok parser. Properties Name Type Description Notes value str Type of logs grok parser. defaults to \"grok-parser\", must be one of [\"grok-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGrokParserType"},{"location":"v1/LogsGrokParserType/#logsgrokparsertype","text":"Type of logs grok parser.","title":"LogsGrokParserType"},{"location":"v1/LogsGrokParserType/#properties","text":"Name Type Description Notes value str Type of logs grok parser. defaults to \"grok-parser\", must be one of [\"grok-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndex/","text":"LogsIndex Object describing a Datadog Log index. Properties Name Type Description Notes filter LogsFilter name str The name of the index. daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] exclusion_filters [LogsExclusion] 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] is_rate_limited bool 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 num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndex"},{"location":"v1/LogsIndex/#logsindex","text":"Object describing a Datadog Log index.","title":"LogsIndex"},{"location":"v1/LogsIndex/#properties","text":"Name Type Description Notes filter LogsFilter name str The name of the index. daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] exclusion_filters [LogsExclusion] 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] is_rate_limited bool 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 num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndexListResponse/","text":"LogsIndexListResponse Object with all Index configurations for a given organization. Properties Name Type Description Notes indexes [LogsIndex] Array of Log index configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndexListResponse"},{"location":"v1/LogsIndexListResponse/#logsindexlistresponse","text":"Object with all Index configurations for a given organization.","title":"LogsIndexListResponse"},{"location":"v1/LogsIndexListResponse/#properties","text":"Name Type Description Notes indexes [LogsIndex] Array of Log index configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndexUpdateRequest/","text":"LogsIndexUpdateRequest Object for updating a Datadog Log index. Properties Name Type Description Notes filter LogsFilter daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] disable_daily_limit bool 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 [LogsExclusion] 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] num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndexUpdateRequest"},{"location":"v1/LogsIndexUpdateRequest/#logsindexupdaterequest","text":"Object for updating a Datadog Log index.","title":"LogsIndexUpdateRequest"},{"location":"v1/LogsIndexUpdateRequest/#properties","text":"Name Type Description Notes filter LogsFilter daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional] disable_daily_limit bool 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 [LogsExclusion] 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] num_retention_days int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsIndexesApi/","text":"datadog_api_client.v1.LogsIndexesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_index POST /api/v1/logs/config/indexes Create an index get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order list_log_indexes GET /api/v1/logs/config/indexes Get all indexes update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order create_logs_index LogsIndex create_logs_index(body) Create an index Creates a new index. Returns the Index object passed in the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndex( daily_limit=300000000, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), is_rate_limited=False, name=\"main\", num_retention_days=15, ) # LogsIndex | Object containing the new index. # example passing only required values which don't have defaults set try: # Create an index api_response = api_instance.create_logs_index(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->create_logs_index: %s\\n\" % e) Parameters Name Type Description Notes body LogsIndex Object containing the new index. Return type LogsIndex Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_index LogsIndex get_logs_index(name) Get an index Get one log index from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. # example passing only required values which don't have defaults set try: # Get an index api_response = api_instance.get_logs_index(name) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index: %s\\n\" % e) Parameters Name Type Description Notes name str Name of the log index. Return type LogsIndex Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_index_order LogsIndexesOrder get_logs_index_order() Get indexes order Get the current order of your log indexes. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get indexes order api_response = api_instance.get_logs_index_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index_order: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsIndexesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_log_indexes LogsIndexListResponse list_log_indexes() Get all indexes The Index object describes the configuration of a log index. This endpoint returns an array of the LogIndex objects of your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all indexes api_response = api_instance.list_log_indexes() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->list_log_indexes: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsIndexListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_index LogsIndex update_logs_index(name, body) Update an index Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful. Using the PUT method updates your index\u2019s configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. body = LogsIndexUpdateRequest( daily_limit=1, disable_daily_limit=True, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), num_retention_days=1, ) # LogsIndexUpdateRequest | Object containing the new `LogsIndexUpdateRequest`. # example passing only required values which don't have defaults set try: # Update an index api_response = api_instance.update_logs_index(name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index: %s\\n\" % e) Parameters Name Type Description Notes name str Name of the log index. body LogsIndexUpdateRequest Object containing the new `LogsIndexUpdateRequest`. Return type LogsIndex Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_index_order LogsIndexesOrder update_logs_index_order(body) Update indexes order This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndexesOrder( index_names=[\"main\",\"payments\",\"web\"], ) # LogsIndexesOrder | Object containing the new ordered list of index names # example passing only required values which don't have defaults set try: # Update indexes order api_response = api_instance.update_logs_index_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index_order: %s\\n\" % e) Parameters Name Type Description Notes body LogsIndexesOrder Object containing the new ordered list of index names Return type LogsIndexesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.LogsIndexesApi"},{"location":"v1/LogsIndexesApi/#datadog_api_clientv1logsindexesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_index POST /api/v1/logs/config/indexes Create an index get_logs_index GET /api/v1/logs/config/indexes/{name} Get an index get_logs_index_order GET /api/v1/logs/config/index-order Get indexes order list_log_indexes GET /api/v1/logs/config/indexes Get all indexes update_logs_index PUT /api/v1/logs/config/indexes/{name} Update an index update_logs_index_order PUT /api/v1/logs/config/index-order Update indexes order","title":"datadog_api_client.v1.LogsIndexesApi"},{"location":"v1/LogsIndexesApi/#create_logs_index","text":"LogsIndex create_logs_index(body) Create an index Creates a new index. Returns the Index object passed in the request body when the request is successful.","title":"create_logs_index"},{"location":"v1/LogsIndexesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndex( daily_limit=300000000, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), is_rate_limited=False, name=\"main\", num_retention_days=15, ) # LogsIndex | Object containing the new index. # example passing only required values which don't have defaults set try: # Create an index api_response = api_instance.create_logs_index(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->create_logs_index: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters","text":"Name Type Description Notes body LogsIndex Object containing the new index.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type","text":"LogsIndex","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#get_logs_index","text":"LogsIndex get_logs_index(name) Get an index Get one log index from your organization. This endpoint takes no JSON arguments.","title":"get_logs_index"},{"location":"v1/LogsIndexesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. # example passing only required values which don't have defaults set try: # Get an index api_response = api_instance.get_logs_index(name) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_1","text":"Name Type Description Notes name str Name of the log index.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_1","text":"LogsIndex","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#get_logs_index_order","text":"LogsIndexesOrder get_logs_index_order() Get indexes order Get the current order of your log indexes. This endpoint takes no JSON arguments.","title":"get_logs_index_order"},{"location":"v1/LogsIndexesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get indexes order api_response = api_instance.get_logs_index_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->get_logs_index_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_2","text":"LogsIndexesOrder","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#list_log_indexes","text":"LogsIndexListResponse list_log_indexes() Get all indexes The Index object describes the configuration of a log index. This endpoint returns an array of the LogIndex objects of your organization.","title":"list_log_indexes"},{"location":"v1/LogsIndexesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all indexes api_response = api_instance.list_log_indexes() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->list_log_indexes: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_3","text":"LogsIndexListResponse","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#update_logs_index","text":"LogsIndex update_logs_index(name, body) Update an index Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful. Using the PUT method updates your index\u2019s configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"update_logs_index"},{"location":"v1/LogsIndexesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) name = \"name_example\" # str | Name of the log index. body = LogsIndexUpdateRequest( daily_limit=1, disable_daily_limit=True, exclusion_filters=[ LogsExclusion( filter=LogsExclusionFilter( query=\"*\", sample_rate=1, ), is_enabled=True, name=\"payment\", ), ], filter=LogsFilter( query=\"source:python\", ), num_retention_days=1, ) # LogsIndexUpdateRequest | Object containing the new `LogsIndexUpdateRequest`. # example passing only required values which don't have defaults set try: # Update an index api_response = api_instance.update_logs_index(name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_4","text":"Name Type Description Notes name str Name of the log index. body LogsIndexUpdateRequest Object containing the new `LogsIndexUpdateRequest`.","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_4","text":"LogsIndex","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Invalid Parameter Error - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesApi/#update_logs_index_order","text":"LogsIndexesOrder update_logs_index_order(body) Update indexes order This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful.","title":"update_logs_index_order"},{"location":"v1/LogsIndexesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_indexes_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_indexes_api.LogsIndexesApi(api_client) body = LogsIndexesOrder( index_names=[\"main\",\"payments\",\"web\"], ) # LogsIndexesOrder | Object containing the new ordered list of index names # example passing only required values which don't have defaults set try: # Update indexes order api_response = api_instance.update_logs_index_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsIndexesApi->update_logs_index_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsIndexesApi/#parameters_5","text":"Name Type Description Notes body LogsIndexesOrder Object containing the new ordered list of index names","title":"Parameters"},{"location":"v1/LogsIndexesApi/#return-type_5","text":"LogsIndexesOrder","title":"Return type"},{"location":"v1/LogsIndexesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsIndexesApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsIndexesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsIndexesOrder/","text":"LogsIndexesOrder Object containing the ordered list of log index names. Properties Name Type Description Notes index_names [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"LogsIndexesOrder"},{"location":"v1/LogsIndexesOrder/#logsindexesorder","text":"Object containing the ordered list of log index names.","title":"LogsIndexesOrder"},{"location":"v1/LogsIndexesOrder/#properties","text":"Name Type Description Notes index_names [str] 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. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsListRequest/","text":"LogsListRequest Object to send with the request to retrieve a list of logs from your Organization. Properties Name Type Description Notes time LogsListRequestTime index str 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 int Number of logs return in the response. [optional] query str The search query - following the log search syntax. [optional] sort LogsSort [optional] start_at str 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequest"},{"location":"v1/LogsListRequest/#logslistrequest","text":"Object to send with the request to retrieve a list of logs from your Organization.","title":"LogsListRequest"},{"location":"v1/LogsListRequest/#properties","text":"Name Type Description Notes time LogsListRequestTime index str 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 int Number of logs return in the response. [optional] query str The search query - following the log search syntax. [optional] sort LogsSort [optional] start_at str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsListRequestTime/","text":"LogsListRequestTime Timeframe to retrieve the log from. Properties Name Type Description Notes _from datetime Minimum timestamp for requested logs. to datetime Maximum timestamp for requested logs. timezone str Timezone can be specified both as an offset (e.g. \\\"UTC+03:00\\\") or a regional zone (e.g. \\\"Europe/Paris\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequestTime"},{"location":"v1/LogsListRequestTime/#logslistrequesttime","text":"Timeframe to retrieve the log from.","title":"LogsListRequestTime"},{"location":"v1/LogsListRequestTime/#properties","text":"Name Type Description Notes _from datetime Minimum timestamp for requested logs. to datetime Maximum timestamp for requested logs. timezone str Timezone can be specified both as an offset (e.g. \\\"UTC+03:00\\\") or a regional zone (e.g. \\\"Europe/Paris\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsListResponse/","text":"LogsListResponse Response object with all logs matching the request and pagination information. Properties Name Type Description Notes logs [Log] Array of logs matching the request and the `nextLogId` if sent. [optional] next_log_id str Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. [optional] status str Status of the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListResponse"},{"location":"v1/LogsListResponse/#logslistresponse","text":"Response object with all logs matching the request and pagination information.","title":"LogsListResponse"},{"location":"v1/LogsListResponse/#properties","text":"Name Type Description Notes logs [Log] Array of logs matching the request and the `nextLogId` if sent. [optional] next_log_id str Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. [optional] status str Status of the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsLookupProcessor/","text":"LogsLookupProcessor Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines. Properties Name Type Description Notes lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` source str Source attribute used to perform the lookup. target str 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 default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsLookupProcessor"},{"location":"v1/LogsLookupProcessor/#logslookupprocessor","text":"Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines.","title":"LogsLookupProcessor"},{"location":"v1/LogsLookupProcessor/#properties","text":"Name Type Description Notes lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` source str Source attribute used to perform the lookup. target str 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 default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsLookupProcessorType/","text":"LogsLookupProcessorType Type of logs lookup processor. Properties Name Type Description Notes value str Type of logs lookup processor. defaults to \"lookup-processor\", must be one of [\"lookup-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsLookupProcessorType"},{"location":"v1/LogsLookupProcessorType/#logslookupprocessortype","text":"Type of logs lookup processor.","title":"LogsLookupProcessorType"},{"location":"v1/LogsLookupProcessorType/#properties","text":"Name Type Description Notes value str Type of logs lookup processor. defaults to \"lookup-processor\", must be one of [\"lookup-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsMessageRemapper/","text":"LogsMessageRemapper The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. Note: If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. Properties Name Type Description Notes type LogsMessageRemapperType sources [str] Array of source attributes. defaults to [\"msg\"] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMessageRemapper"},{"location":"v1/LogsMessageRemapper/#logsmessageremapper","text":"The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. Note: If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.","title":"LogsMessageRemapper"},{"location":"v1/LogsMessageRemapper/#properties","text":"Name Type Description Notes type LogsMessageRemapperType sources [str] Array of source attributes. defaults to [\"msg\"] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsMessageRemapperType/","text":"LogsMessageRemapperType Type of logs message remapper. Properties Name Type Description Notes value str Type of logs message remapper. defaults to \"message-remapper\", must be one of [\"message-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMessageRemapperType"},{"location":"v1/LogsMessageRemapperType/#logsmessageremappertype","text":"Type of logs message remapper.","title":"LogsMessageRemapperType"},{"location":"v1/LogsMessageRemapperType/#properties","text":"Name Type Description Notes value str Type of logs message remapper. defaults to \"message-remapper\", must be one of [\"message-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipeline/","text":"LogsPipeline Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note : These endpoints are only available for admin users. Make sure to use an application key created by an admin. Properties Name Type Description Notes name str Name of the pipeline. filter LogsFilter [optional] id str ID of the pipeline. optional is_enabled bool Whether or not the pipeline is enabled. [optional] is_read_only bool Whether or not the pipeline can be edited. optional processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] type str Type of pipeline. optional [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipeline"},{"location":"v1/LogsPipeline/#logspipeline","text":"Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note : These endpoints are only available for admin users. Make sure to use an application key created by an admin.","title":"LogsPipeline"},{"location":"v1/LogsPipeline/#properties","text":"Name Type Description Notes name str Name of the pipeline. filter LogsFilter [optional] id str ID of the pipeline. optional is_enabled bool Whether or not the pipeline is enabled. [optional] is_read_only bool Whether or not the pipeline can be edited. optional processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] type str Type of pipeline. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelineList/","text":"LogsPipelineList Array of pipeline ID strings. Properties Name Type Description Notes value [LogsPipeline] Array of pipeline ID strings. [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelineList"},{"location":"v1/LogsPipelineList/#logspipelinelist","text":"Array of pipeline ID strings.","title":"LogsPipelineList"},{"location":"v1/LogsPipelineList/#properties","text":"Name Type Description Notes value [LogsPipeline] Array of pipeline ID strings. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelineProcessor/","text":"LogsPipelineProcessor Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors. Properties Name Type Description Notes type LogsPipelineProcessorType filter LogsFilter [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelineProcessor"},{"location":"v1/LogsPipelineProcessor/#logspipelineprocessor","text":"Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors.","title":"LogsPipelineProcessor"},{"location":"v1/LogsPipelineProcessor/#properties","text":"Name Type Description Notes type LogsPipelineProcessorType filter LogsFilter [optional] is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelineProcessorType/","text":"LogsPipelineProcessorType Type of logs pipeline processor. Properties Name Type Description Notes value str Type of logs pipeline processor. defaults to \"pipeline\", must be one of [\"pipeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelineProcessorType"},{"location":"v1/LogsPipelineProcessorType/#logspipelineprocessortype","text":"Type of logs pipeline processor.","title":"LogsPipelineProcessorType"},{"location":"v1/LogsPipelineProcessorType/#properties","text":"Name Type Description Notes value str Type of logs pipeline processor. defaults to \"pipeline\", must be one of [\"pipeline\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsPipelinesApi/","text":"datadog_api_client.v1.LogsPipelinesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order create_logs_pipeline LogsPipeline create_logs_pipeline(body) Create a pipeline Create a pipeline in your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | Definition of the new pipeline. # example passing only required values which don't have defaults set try: # Create a pipeline api_response = api_instance.create_logs_pipeline(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->create_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes body LogsPipeline Definition of the new pipeline. Return type LogsPipeline Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_logs_pipeline delete_logs_pipeline(pipeline_id) Delete a pipeline Delete a given pipeline from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. # example passing only required values which don't have defaults set try: # Delete a pipeline api_instance.delete_logs_pipeline(pipeline_id) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->delete_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes pipeline_id str ID of the pipeline to delete. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_pipeline LogsPipeline get_logs_pipeline(pipeline_id) Get a pipeline Get a specific pipeline from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to get. # example passing only required values which don't have defaults set try: # Get a pipeline api_response = api_instance.get_logs_pipeline(pipeline_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes pipeline_id str ID of the pipeline to get. Return type LogsPipeline Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_pipeline_order LogsPipelinesOrder get_logs_pipeline_order() Get pipeline order Get the current order of your pipelines. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get pipeline order api_response = api_instance.get_logs_pipeline_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline_order: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsPipelinesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_pipelines LogsPipelineList list_logs_pipelines() Get all pipelines Get all pipelines from your organization. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all pipelines api_response = api_instance.list_logs_pipelines() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->list_logs_pipelines: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsPipelineList Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_pipeline LogsPipeline update_logs_pipeline(pipeline_id, body) Update a pipeline Update a given pipeline configuration to change it\u2019s processors or their order. Note : Using this method updates your pipeline configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | New definition of the pipeline. # example passing only required values which don't have defaults set try: # Update a pipeline api_response = api_instance.update_logs_pipeline(pipeline_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline: %s\\n\" % e) Parameters Name Type Description Notes pipeline_id str ID of the pipeline to delete. body LogsPipeline New definition of the pipeline. Return type LogsPipeline Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_pipeline_order LogsPipelinesOrder update_logs_pipeline_order(body) Update pipeline order Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors. Note : Using the PUT method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipelinesOrder( pipeline_ids=[\"tags\",\"org_ids\",\"products\"], ) # LogsPipelinesOrder | Object containing the new ordered list of pipeline IDs. # example passing only required values which don't have defaults set try: # Update pipeline order api_response = api_instance.update_logs_pipeline_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline_order: %s\\n\" % e) Parameters Name Type Description Notes body LogsPipelinesOrder Object containing the new ordered list of pipeline IDs. Return type LogsPipelinesOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.LogsPipelinesApi"},{"location":"v1/LogsPipelinesApi/#datadog_api_clientv1logspipelinesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_pipeline POST /api/v1/logs/config/pipelines Create a pipeline delete_logs_pipeline DELETE /api/v1/logs/config/pipelines/{pipeline_id} Delete a pipeline get_logs_pipeline GET /api/v1/logs/config/pipelines/{pipeline_id} Get a pipeline get_logs_pipeline_order GET /api/v1/logs/config/pipeline-order Get pipeline order list_logs_pipelines GET /api/v1/logs/config/pipelines Get all pipelines update_logs_pipeline PUT /api/v1/logs/config/pipelines/{pipeline_id} Update a pipeline update_logs_pipeline_order PUT /api/v1/logs/config/pipeline-order Update pipeline order","title":"datadog_api_client.v1.LogsPipelinesApi"},{"location":"v1/LogsPipelinesApi/#create_logs_pipeline","text":"LogsPipeline create_logs_pipeline(body) Create a pipeline Create a pipeline in your organization.","title":"create_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | Definition of the new pipeline. # example passing only required values which don't have defaults set try: # Create a pipeline api_response = api_instance.create_logs_pipeline(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->create_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters","text":"Name Type Description Notes body LogsPipeline Definition of the new pipeline.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type","text":"LogsPipeline","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#delete_logs_pipeline","text":"delete_logs_pipeline(pipeline_id) Delete a pipeline Delete a given pipeline from your organization. This endpoint takes no JSON arguments.","title":"delete_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. # example passing only required values which don't have defaults set try: # Delete a pipeline api_instance.delete_logs_pipeline(pipeline_id) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->delete_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_1","text":"Name Type Description Notes pipeline_id str ID of the pipeline to delete.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#get_logs_pipeline","text":"LogsPipeline get_logs_pipeline(pipeline_id) Get a pipeline Get a specific pipeline from your organization. This endpoint takes no JSON arguments.","title":"get_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to get. # example passing only required values which don't have defaults set try: # Get a pipeline api_response = api_instance.get_logs_pipeline(pipeline_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_2","text":"Name Type Description Notes pipeline_id str ID of the pipeline to get.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_2","text":"LogsPipeline","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#get_logs_pipeline_order","text":"LogsPipelinesOrder get_logs_pipeline_order() Get pipeline order Get the current order of your pipelines. This endpoint takes no JSON arguments.","title":"get_logs_pipeline_order"},{"location":"v1/LogsPipelinesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get pipeline order api_response = api_instance.get_logs_pipeline_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->get_logs_pipeline_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_3","text":"LogsPipelinesOrder","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#list_logs_pipelines","text":"LogsPipelineList list_logs_pipelines() Get all pipelines Get all pipelines from your organization. This endpoint takes no JSON arguments.","title":"list_logs_pipelines"},{"location":"v1/LogsPipelinesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all pipelines api_response = api_instance.list_logs_pipelines() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->list_logs_pipelines: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_4","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_4","text":"LogsPipelineList","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#update_logs_pipeline","text":"LogsPipeline update_logs_pipeline(pipeline_id, body) Update a pipeline Update a given pipeline configuration to change it\u2019s processors or their order. Note : Using this method updates your pipeline configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"update_logs_pipeline"},{"location":"v1/LogsPipelinesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) pipeline_id = \"pipeline_id_example\" # str | ID of the pipeline to delete. body = LogsPipeline( filter=LogsFilter( query=\"source:python\", ), id=\"id_example\", is_enabled=True, is_read_only=True, name=\"\", processors=[ LogsProcessor(), ], type=\"pipeline\", ) # LogsPipeline | New definition of the pipeline. # example passing only required values which don't have defaults set try: # Update a pipeline api_response = api_instance.update_logs_pipeline(pipeline_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_5","text":"Name Type Description Notes pipeline_id str ID of the pipeline to delete. body LogsPipeline New definition of the pipeline.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_5","text":"LogsPipeline","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesApi/#update_logs_pipeline_order","text":"LogsPipelinesOrder update_logs_pipeline_order(body) Update pipeline order Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors. Note : Using the PUT method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization.","title":"update_logs_pipeline_order"},{"location":"v1/LogsPipelinesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import logs_pipelines_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_pipelines_api.LogsPipelinesApi(api_client) body = LogsPipelinesOrder( pipeline_ids=[\"tags\",\"org_ids\",\"products\"], ) # LogsPipelinesOrder | Object containing the new ordered list of pipeline IDs. # example passing only required values which don't have defaults set try: # Update pipeline order api_response = api_instance.update_logs_pipeline_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsPipelinesApi->update_logs_pipeline_order: %s\\n\" % e)","title":"Example"},{"location":"v1/LogsPipelinesApi/#parameters_6","text":"Name Type Description Notes body LogsPipelinesOrder Object containing the new ordered list of pipeline IDs.","title":"Parameters"},{"location":"v1/LogsPipelinesApi/#return-type_6","text":"LogsPipelinesOrder","title":"Return type"},{"location":"v1/LogsPipelinesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/LogsPipelinesApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/LogsPipelinesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/LogsPipelinesOrder/","text":"LogsPipelinesOrder Object containing the ordered list of pipeline IDs. Properties Name Type Description Notes pipeline_ids [str] Ordered Array of `` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"LogsPipelinesOrder"},{"location":"v1/LogsPipelinesOrder/#logspipelinesorder","text":"Object containing the ordered list of pipeline IDs.","title":"LogsPipelinesOrder"},{"location":"v1/LogsPipelinesOrder/#properties","text":"Name Type Description Notes pipeline_ids [str] Ordered Array of `` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsProcessor/","text":"LogsProcessor Definition of a logs processor. Properties Name Type Description Notes is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False filter LogsFilter [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] grok LogsGrokParserRules [optional] source str Source attribute used to perform the lookup. [optional] type LogsTraceRemapperType [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. [optional] categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. [optional] expression str Arithmetic operation between one or more log attributes. [optional] template str A formula with one or more attributes and raw text. [optional] lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsProcessor"},{"location":"v1/LogsProcessor/#logsprocessor","text":"Definition of a logs processor.","title":"LogsProcessor"},{"location":"v1/LogsProcessor/#properties","text":"Name Type Description Notes is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] samples [str] List of sample logs to test this grok parser. [optional] override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" target_format TargetFormatType [optional] target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of \"attribute\" normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False filter LogsFilter [optional] processors [LogsProcessor] Ordered list of processors in this pipeline. [optional] default_lookup str Value to set the target attribute if the source value is not found in the list. [optional] grok LogsGrokParserRules [optional] source str Source attribute used to perform the lookup. [optional] type LogsTraceRemapperType [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. [optional] categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. [optional] expression str Arithmetic operation between one or more log attributes. [optional] template str A formula with one or more attributes and raw text. [optional] lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\\\"source_key1,target_value1\\\", \\\"source_key2,target_value2\\\"]` [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsQueryCompute/","text":"LogsQueryCompute Define computation for a log query. Properties Name Type Description Notes aggregation str The aggregation method. facet str Facet name. [optional] interval int Define a time interval in seconds. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsQueryCompute"},{"location":"v1/LogsQueryCompute/#logsquerycompute","text":"Define computation for a log query.","title":"LogsQueryCompute"},{"location":"v1/LogsQueryCompute/#properties","text":"Name Type Description Notes aggregation str The aggregation method. facet str Facet name. [optional] interval int Define a time interval in seconds. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsRetentionAggSumUsage/","text":"LogsRetentionAggSumUsage Object containing indexed logs usage aggregated across organizations and months for a retention period. Properties Name Type Description Notes logs_indexed_logs_usage_agg_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_agg_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_agg_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsRetentionAggSumUsage"},{"location":"v1/LogsRetentionAggSumUsage/#logsretentionaggsumusage","text":"Object containing indexed logs usage aggregated across organizations and months for a retention period.","title":"LogsRetentionAggSumUsage"},{"location":"v1/LogsRetentionAggSumUsage/#properties","text":"Name Type Description Notes logs_indexed_logs_usage_agg_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_agg_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_agg_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsRetentionSumUsage/","text":"LogsRetentionSumUsage Object containing indexed logs usage grouped by retention period and summed. Properties Name Type Description Notes logs_indexed_logs_usage_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsRetentionSumUsage"},{"location":"v1/LogsRetentionSumUsage/#logsretentionsumusage","text":"Object containing indexed logs usage grouped by retention period and summed.","title":"LogsRetentionSumUsage"},{"location":"v1/LogsRetentionSumUsage/#properties","text":"Name Type Description Notes logs_indexed_logs_usage_sum int Total indexed logs for this retention period. [optional] logs_live_indexed_logs_usage_sum int Live indexed logs for this retention period. [optional] logs_rehydrated_indexed_logs_usage_sum int Rehydrated indexed logs for this retention period. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention periods. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsServiceRemapper/","text":"LogsServiceRemapper Use this processor if you want to assign one or more attributes as the official service. Note: If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. Properties Name Type Description Notes sources [str] Array of source attributes. type LogsServiceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsServiceRemapper"},{"location":"v1/LogsServiceRemapper/#logsserviceremapper","text":"Use this processor if you want to assign one or more attributes as the official service. Note: If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.","title":"LogsServiceRemapper"},{"location":"v1/LogsServiceRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. type LogsServiceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsServiceRemapperType/","text":"LogsServiceRemapperType Type of logs service remapper. Properties Name Type Description Notes value str Type of logs service remapper. defaults to \"service-remapper\", must be one of [\"service-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsServiceRemapperType"},{"location":"v1/LogsServiceRemapperType/#logsserviceremappertype","text":"Type of logs service remapper.","title":"LogsServiceRemapperType"},{"location":"v1/LogsServiceRemapperType/#properties","text":"Name Type Description Notes value str Type of logs service remapper. defaults to \"service-remapper\", must be one of [\"service-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsSort/","text":"LogsSort Time-ascending asc or time-descending desc results. Properties Name Type Description Notes value str Time-ascending `asc` or time-descending `desc`results. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsSort"},{"location":"v1/LogsSort/#logssort","text":"Time-ascending asc or time-descending desc results.","title":"LogsSort"},{"location":"v1/LogsSort/#properties","text":"Name Type Description Notes value str Time-ascending `asc` or time-descending `desc`results. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStatusRemapper/","text":"LogsStatusRemapper Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with emerg or f (case-insensitive) map to emerg (0) - Strings beginning with a (case-insensitive) map to alert (1) - Strings beginning with c (case-insensitive) map to critical (2) - Strings beginning with err (case-insensitive) map to error (3) - Strings beginning with w (case-insensitive) map to warning (4) - Strings beginning with n (case-insensitive) map to notice (5) - Strings beginning with i (case-insensitive) map to info (6) - Strings beginning with d , trace or verbose (case-insensitive) map to debug (7) - Strings beginning with o or matching OK or Success (case-insensitive) map to OK - All others map to info (6) Note: If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. Properties Name Type Description Notes sources [str] Array of source attributes. type LogsStatusRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStatusRemapper"},{"location":"v1/LogsStatusRemapper/#logsstatusremapper","text":"Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with emerg or f (case-insensitive) map to emerg (0) - Strings beginning with a (case-insensitive) map to alert (1) - Strings beginning with c (case-insensitive) map to critical (2) - Strings beginning with err (case-insensitive) map to error (3) - Strings beginning with w (case-insensitive) map to warning (4) - Strings beginning with n (case-insensitive) map to notice (5) - Strings beginning with i (case-insensitive) map to info (6) - Strings beginning with d , trace or verbose (case-insensitive) map to debug (7) - Strings beginning with o or matching OK or Success (case-insensitive) map to OK - All others map to info (6) Note: If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.","title":"LogsStatusRemapper"},{"location":"v1/LogsStatusRemapper/#properties","text":"Name Type Description Notes sources [str] Array of source attributes. type LogsStatusRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStatusRemapperType/","text":"LogsStatusRemapperType Type of logs status remapper. Properties Name Type Description Notes value str Type of logs status remapper. defaults to \"status-remapper\", must be one of [\"status-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStatusRemapperType"},{"location":"v1/LogsStatusRemapperType/#logsstatusremappertype","text":"Type of logs status remapper.","title":"LogsStatusRemapperType"},{"location":"v1/LogsStatusRemapperType/#properties","text":"Name Type Description Notes value str Type of logs status remapper. defaults to \"status-remapper\", must be one of [\"status-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStringBuilderProcessor/","text":"LogsStringBuilderProcessor Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax %{attribute_path} . Notes : - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters. Properties Name Type Description Notes target str The name of the attribute that contains the result of the template. template str A formula with one or more attributes and raw text. type LogsStringBuilderProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStringBuilderProcessor"},{"location":"v1/LogsStringBuilderProcessor/#logsstringbuilderprocessor","text":"Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax %{attribute_path} . Notes : - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters.","title":"LogsStringBuilderProcessor"},{"location":"v1/LogsStringBuilderProcessor/#properties","text":"Name Type Description Notes target str The name of the attribute that contains the result of the template. template str A formula with one or more attributes and raw text. type LogsStringBuilderProcessorType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsStringBuilderProcessorType/","text":"LogsStringBuilderProcessorType Type of logs string builder processor. Properties Name Type Description Notes value str Type of logs string builder processor. defaults to \"string-builder-processor\", must be one of [\"string-builder-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsStringBuilderProcessorType"},{"location":"v1/LogsStringBuilderProcessorType/#logsstringbuilderprocessortype","text":"Type of logs string builder processor.","title":"LogsStringBuilderProcessorType"},{"location":"v1/LogsStringBuilderProcessorType/#properties","text":"Name Type Description Notes value str Type of logs string builder processor. defaults to \"string-builder-processor\", must be one of [\"string-builder-processor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsTraceRemapper/","text":"LogsTraceRemapper There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on how to inject a trace ID in the application logs and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID. Properties Name Type Description Notes type LogsTraceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] [Back to Model list] [Back to API list] [Back to README]","title":"LogsTraceRemapper"},{"location":"v1/LogsTraceRemapper/#logstraceremapper","text":"There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on how to inject a trace ID in the application logs and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID.","title":"LogsTraceRemapper"},{"location":"v1/LogsTraceRemapper/#properties","text":"Name Type Description Notes type LogsTraceRemapperType is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] sources [str] Array of source attributes. [optional] if omitted the server will use the default value of [\"dd.trace_id\"] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsTraceRemapperType/","text":"LogsTraceRemapperType Type of logs trace remapper. Properties Name Type Description Notes value str Type of logs trace remapper. defaults to \"trace-id-remapper\", must be one of [\"trace-id-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsTraceRemapperType"},{"location":"v1/LogsTraceRemapperType/#logstraceremappertype","text":"Type of logs trace remapper.","title":"LogsTraceRemapperType"},{"location":"v1/LogsTraceRemapperType/#properties","text":"Name Type Description Notes value str Type of logs trace remapper. defaults to \"trace-id-remapper\", must be one of [\"trace-id-remapper\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsURLParser/","text":"LogsURLParser This processor extracts query parameters and other important parameters from a URL. Properties Name Type Description Notes type LogsURLParserType sources [str] Array of source attributes. defaults to [\"http.url\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.url_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"LogsURLParser"},{"location":"v1/LogsURLParser/#logsurlparser","text":"This processor extracts query parameters and other important parameters from a URL.","title":"LogsURLParser"},{"location":"v1/LogsURLParser/#properties","text":"Name Type Description Notes type LogsURLParserType sources [str] Array of source attributes. defaults to [\"http.url\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.url_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsURLParserType/","text":"LogsURLParserType Type of logs URL parser. Properties Name Type Description Notes value str Type of logs URL parser. defaults to \"url-parser\", must be one of [\"url-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsURLParserType"},{"location":"v1/LogsURLParserType/#logsurlparsertype","text":"Type of logs URL parser.","title":"LogsURLParserType"},{"location":"v1/LogsURLParserType/#properties","text":"Name Type Description Notes value str Type of logs URL parser. defaults to \"url-parser\", must be one of [\"url-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsUserAgentParser/","text":"LogsUserAgentParser The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing. Properties Name Type Description Notes type LogsUserAgentParserType sources [str] Array of source attributes. defaults to [\"http.useragent\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.useragent_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsUserAgentParser"},{"location":"v1/LogsUserAgentParser/#logsuseragentparser","text":"The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing.","title":"LogsUserAgentParser"},{"location":"v1/LogsUserAgentParser/#properties","text":"Name Type Description Notes type LogsUserAgentParserType sources [str] Array of source attributes. defaults to [\"http.useragent\"] target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to \"http.useragent_details\" is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False name str Name of the processor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/LogsUserAgentParserType/","text":"LogsUserAgentParserType Type of logs User-Agent parser. Properties Name Type Description Notes value str Type of logs User-Agent parser. defaults to \"user-agent-parser\", must be one of [\"user-agent-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsUserAgentParserType"},{"location":"v1/LogsUserAgentParserType/#logsuseragentparsertype","text":"Type of logs User-Agent parser.","title":"LogsUserAgentParserType"},{"location":"v1/LogsUserAgentParserType/#properties","text":"Name Type Description Notes value str Type of logs User-Agent parser. defaults to \"user-agent-parser\", must be one of [\"user-agent-parser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricMetadata/","text":"MetricMetadata Object with all metric related metadata. Properties Name Type Description Notes description str Metric description. [optional] integration str Name of the integration that sent the metric if applicable. optional per_unit str Per unit of the metric such as `second` in `bytes per second`. [optional] short_name str A more human-readable and abbreviated version of the metric name. [optional] statsd_interval int StatsD flush interval of the metric in seconds if applicable. [optional] type str Metric type such as `gauge` or `rate`. [optional] unit str Primary unit of the metric such as `byte` or `operation`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricMetadata"},{"location":"v1/MetricMetadata/#metricmetadata","text":"Object with all metric related metadata.","title":"MetricMetadata"},{"location":"v1/MetricMetadata/#properties","text":"Name Type Description Notes description str Metric description. [optional] integration str Name of the integration that sent the metric if applicable. optional per_unit str Per unit of the metric such as `second` in `bytes per second`. [optional] short_name str A more human-readable and abbreviated version of the metric name. [optional] statsd_interval int StatsD flush interval of the metric in seconds if applicable. [optional] type str Metric type such as `gauge` or `rate`. [optional] unit str Primary unit of the metric such as `byte` or `operation`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricSearchResponse/","text":"MetricSearchResponse Object containing the list of metrics matching the search query. Properties Name Type Description Notes results MetricSearchResponseResults [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricSearchResponse"},{"location":"v1/MetricSearchResponse/#metricsearchresponse","text":"Object containing the list of metrics matching the search query.","title":"MetricSearchResponse"},{"location":"v1/MetricSearchResponse/#properties","text":"Name Type Description Notes results MetricSearchResponseResults [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricSearchResponseResults/","text":"MetricSearchResponseResults Search result. Properties Name Type Description Notes metrics [str] List of metrics that match the search query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricSearchResponseResults"},{"location":"v1/MetricSearchResponseResults/#metricsearchresponseresults","text":"Search result.","title":"MetricSearchResponseResults"},{"location":"v1/MetricSearchResponseResults/#properties","text":"Name Type Description Notes metrics [str] List of metrics that match the search query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsApi/","text":"datadog_api_client.v1.MetricsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata list_active_metrics GET /api/v1/metrics Get active metrics list list_metrics GET /api/v1/search Search metrics query_metrics GET /api/v1/query Query timeseries points submit_metrics POST /api/v1/series Submit metrics update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata get_metric_metadata MetricMetadata get_metric_metadata(metric_name) Get metric metadata Get metadata about a specific metric. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to get metadata. # example passing only required values which don't have defaults set try: # Get metric metadata api_response = api_instance.get_metric_metadata(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->get_metric_metadata: %s\\n\" % e) Parameters Name Type Description Notes metric_name str Name of the metric for which to get metadata. Return type MetricMetadata Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_active_metrics MetricsListResponse list_active_metrics(_from) Get active metrics list Get the list of actively reporting metrics from a given time until now. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Seconds since the Unix epoch. host = \"host_example\" # str | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. (optional) tag_filter = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) # example passing only required values which don't have defaults set try: # Get active metrics list api_response = api_instance.list_active_metrics(_from) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get active metrics list api_response = api_instance.list_active_metrics(_from, host=host, tag_filter=tag_filter) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e) Parameters Name Type Description Notes _from int Seconds since the Unix epoch. host str Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. [optional] tag_filter str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional] Return type MetricsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_metrics MetricSearchResponse list_metrics(q) Search metrics Search for metrics from the last 24 hours in Datadog. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) q = \"q_example\" # str | Query string to search metrics upon. Must be prefixed with `metrics:`. # example passing only required values which don't have defaults set try: # Search metrics api_response = api_instance.list_metrics(q) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_metrics: %s\\n\" % e) Parameters Name Type Description Notes q str Query string to search metrics upon. Must be prefixed with `metrics:`. Return type MetricSearchResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] query_metrics MetricsQueryResponse query_metrics(_from, to, query) Query timeseries points Query timeseries points. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Start of the queried time period, seconds since the Unix epoch. to = 1 # int | End of the queried time period, seconds since the Unix epoch. query = \"query_example\" # str | Query string. # example passing only required values which don't have defaults set try: # Query timeseries points api_response = api_instance.query_metrics(_from, to, query) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->query_metrics: %s\\n\" % e) Parameters Name Type Description Notes _from int Start of the queried time period, seconds since the Unix epoch. to int End of the queried time period, seconds since the Unix epoch. query str Query string. Return type MetricsQueryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] submit_metrics IntakePayloadAccepted submit_metrics(body) Submit metrics The metrics end-point allows you to post time-series data that can be graphed on Datadog\u2019s dashboards. The maximum payload size is 3.2 megabytes (3200000). Compressed payloads must have a decompressed size of up to 62 megabytes (62914560). If you\u2019re submitting metrics directly to the Datadog API without using DogStatsD, expect - 64 bits for the timestamp - 32 bits for the value - 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. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) body = MetricsPayload( series=[ Series( host=\"test.example.com\", interval=20, metric=\"system.load.1\", points=[ Point([[1575317847,0.5]]), ], tags=[\"environment:test\"], type=\"rate\", ), ], ) # MetricsPayload | # example passing only required values which don't have defaults set try: # Submit metrics api_response = api_instance.submit_metrics(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->submit_metrics: %s\\n\" % e) Parameters Name Type Description Notes body MetricsPayload Return type IntakePayloadAccepted Authorization apiKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_metric_metadata MetricMetadata update_metric_metadata(metric_name, body) Edit metric metadata Edit metadata of a specific metric. Find out more about supported types . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to edit metadata. body = MetricMetadata( description=\"description_example\", integration=\"integration_example\", per_unit=\"second\", short_name=\"short_name_example\", statsd_interval=1, type=\"count\", unit=\"byte\", ) # MetricMetadata | New metadata. # example passing only required values which don't have defaults set try: # Edit metric metadata api_response = api_instance.update_metric_metadata(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_metric_metadata: %s\\n\" % e) Parameters Name Type Description Notes metric_name str Name of the metric for which to edit metadata. body MetricMetadata New metadata. Return type MetricMetadata Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.MetricsApi"},{"location":"v1/MetricsApi/#datadog_api_clientv1metricsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_metric_metadata GET /api/v1/metrics/{metric_name} Get metric metadata list_active_metrics GET /api/v1/metrics Get active metrics list list_metrics GET /api/v1/search Search metrics query_metrics GET /api/v1/query Query timeseries points submit_metrics POST /api/v1/series Submit metrics update_metric_metadata PUT /api/v1/metrics/{metric_name} Edit metric metadata","title":"datadog_api_client.v1.MetricsApi"},{"location":"v1/MetricsApi/#get_metric_metadata","text":"MetricMetadata get_metric_metadata(metric_name) Get metric metadata Get metadata about a specific metric.","title":"get_metric_metadata"},{"location":"v1/MetricsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to get metadata. # example passing only required values which don't have defaults set try: # Get metric metadata api_response = api_instance.get_metric_metadata(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->get_metric_metadata: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters","text":"Name Type Description Notes metric_name str Name of the metric for which to get metadata.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type","text":"MetricMetadata","title":"Return type"},{"location":"v1/MetricsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#list_active_metrics","text":"MetricsListResponse list_active_metrics(_from) Get active metrics list Get the list of actively reporting metrics from a given time until now.","title":"list_active_metrics"},{"location":"v1/MetricsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Seconds since the Unix epoch. host = \"host_example\" # str | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. (optional) tag_filter = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) # example passing only required values which don't have defaults set try: # Get active metrics list api_response = api_instance.list_active_metrics(_from) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get active metrics list api_response = api_instance.list_active_metrics(_from, host=host, tag_filter=tag_filter) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_active_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_1","text":"Name Type Description Notes _from int Seconds since the Unix epoch. host str Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. [optional] tag_filter str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional]","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_1","text":"MetricsListResponse","title":"Return type"},{"location":"v1/MetricsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#list_metrics","text":"MetricSearchResponse list_metrics(q) Search metrics Search for metrics from the last 24 hours in Datadog.","title":"list_metrics"},{"location":"v1/MetricsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) q = \"q_example\" # str | Query string to search metrics upon. Must be prefixed with `metrics:`. # example passing only required values which don't have defaults set try: # Search metrics api_response = api_instance.list_metrics(q) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_2","text":"Name Type Description Notes q str Query string to search metrics upon. Must be prefixed with `metrics:`.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_2","text":"MetricSearchResponse","title":"Return type"},{"location":"v1/MetricsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#query_metrics","text":"MetricsQueryResponse query_metrics(_from, to, query) Query timeseries points Query timeseries points.","title":"query_metrics"},{"location":"v1/MetricsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) _from = 1 # int | Start of the queried time period, seconds since the Unix epoch. to = 1 # int | End of the queried time period, seconds since the Unix epoch. query = \"query_example\" # str | Query string. # example passing only required values which don't have defaults set try: # Query timeseries points api_response = api_instance.query_metrics(_from, to, query) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->query_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_3","text":"Name Type Description Notes _from int Start of the queried time period, seconds since the Unix epoch. to int End of the queried time period, seconds since the Unix epoch. query str Query string.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_3","text":"MetricsQueryResponse","title":"Return type"},{"location":"v1/MetricsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#submit_metrics","text":"IntakePayloadAccepted submit_metrics(body) Submit metrics The metrics end-point allows you to post time-series data that can be graphed on Datadog\u2019s dashboards. The maximum payload size is 3.2 megabytes (3200000). Compressed payloads must have a decompressed size of up to 62 megabytes (62914560). If you\u2019re submitting metrics directly to the Datadog API without using DogStatsD, expect - 64 bits for the timestamp - 32 bits for the value - 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.","title":"submit_metrics"},{"location":"v1/MetricsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) body = MetricsPayload( series=[ Series( host=\"test.example.com\", interval=20, metric=\"system.load.1\", points=[ Point([[1575317847,0.5]]), ], tags=[\"environment:test\"], type=\"rate\", ), ], ) # MetricsPayload | # example passing only required values which don't have defaults set try: # Submit metrics api_response = api_instance.submit_metrics(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->submit_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_4","text":"Name Type Description Notes body MetricsPayload","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_4","text":"IntakePayloadAccepted","title":"Return type"},{"location":"v1/MetricsApi/#authorization_4","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_4","text":"Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsApi/#update_metric_metadata","text":"MetricMetadata update_metric_metadata(metric_name, body) Edit metric metadata Edit metadata of a specific metric. Find out more about supported types .","title":"update_metric_metadata"},{"location":"v1/MetricsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import metrics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"metric_name_example\" # str | Name of the metric for which to edit metadata. body = MetricMetadata( description=\"description_example\", integration=\"integration_example\", per_unit=\"second\", short_name=\"short_name_example\", statsd_interval=1, type=\"count\", unit=\"byte\", ) # MetricMetadata | New metadata. # example passing only required values which don't have defaults set try: # Edit metric metadata api_response = api_instance.update_metric_metadata(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_metric_metadata: %s\\n\" % e)","title":"Example"},{"location":"v1/MetricsApi/#parameters_5","text":"Name Type Description Notes metric_name str Name of the metric for which to edit metadata. body MetricMetadata New metadata.","title":"Parameters"},{"location":"v1/MetricsApi/#return-type_5","text":"MetricMetadata","title":"Return type"},{"location":"v1/MetricsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MetricsApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MetricsApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MetricsListResponse/","text":"MetricsListResponse Object listing all metric names stored by Datadog since a given time. Properties Name Type Description Notes _from str Time when the metrics were active, seconds since the Unix epoch. [optional] metrics [str] List of metric names. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricsListResponse"},{"location":"v1/MetricsListResponse/#metricslistresponse","text":"Object listing all metric names stored by Datadog since a given time.","title":"MetricsListResponse"},{"location":"v1/MetricsListResponse/#properties","text":"Name Type Description Notes _from str Time when the metrics were active, seconds since the Unix epoch. [optional] metrics [str] List of metric names. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsPayload/","text":"MetricsPayload The metrics' payload. Properties Name Type Description Notes series [Series] A list of time series to submit to Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"MetricsPayload"},{"location":"v1/MetricsPayload/#metricspayload","text":"The metrics' payload.","title":"MetricsPayload"},{"location":"v1/MetricsPayload/#properties","text":"Name Type Description Notes series [Series] A list of time series to submit to Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsQueryMetadata/","text":"MetricsQueryMetadata Object containing all metric names returned and their associated metadata. Properties Name Type Description Notes aggr str Aggregation type. optional display_name str Display name of the metric. optional end int End of the time window, milliseconds since Unix epoch. optional expression str Metric expression. optional interval int Number of seconds between data samples. optional length int Number of data samples. optional metric str Metric name. optional pointlist [Point] List of points of the time series. optional scope str Metric scope, comma separated list of tags. optional start int Start of the time window, milliseconds since Unix epoch. optional unit [MetricsQueryUnit] 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 [Back to Model list] [Back to API list] [Back to README]","title":"MetricsQueryMetadata"},{"location":"v1/MetricsQueryMetadata/#metricsquerymetadata","text":"Object containing all metric names returned and their associated metadata.","title":"MetricsQueryMetadata"},{"location":"v1/MetricsQueryMetadata/#properties","text":"Name Type Description Notes aggr str Aggregation type. optional display_name str Display name of the metric. optional end int End of the time window, milliseconds since Unix epoch. optional expression str Metric expression. optional interval int Number of seconds between data samples. optional length int Number of data samples. optional metric str Metric name. optional pointlist [Point] List of points of the time series. optional scope str Metric scope, comma separated list of tags. optional start int Start of the time window, milliseconds since Unix epoch. optional unit [MetricsQueryUnit] 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 [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsQueryResponse/","text":"MetricsQueryResponse Response Object that includes your query and the list of metrics retrieved. Properties Name Type Description Notes error str Message indicating the errors if status is not `ok`. optional from_date int Start of requested time window, milliseconds since Unix epoch. optional group_by [str] List of tag keys on which to group. optional message str Message indicating `success` if status is `ok`. optional query str Query string optional res_type str Type of response. optional series [MetricsQueryMetadata] List of timeseries queried. optional status str Status of the query. optional to_date int End of requested time window, milliseconds since Unix epoch. optional [Back to Model list] [Back to API list] [Back to README]","title":"MetricsQueryResponse"},{"location":"v1/MetricsQueryResponse/#metricsqueryresponse","text":"Response Object that includes your query and the list of metrics retrieved.","title":"MetricsQueryResponse"},{"location":"v1/MetricsQueryResponse/#properties","text":"Name Type Description Notes error str Message indicating the errors if status is not `ok`. optional from_date int Start of requested time window, milliseconds since Unix epoch. optional group_by [str] List of tag keys on which to group. optional message str Message indicating `success` if status is `ok`. optional query str Query string optional res_type str Type of response. optional series [MetricsQueryMetadata] List of timeseries queried. optional status str Status of the query. optional to_date int End of requested time window, milliseconds since Unix epoch. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MetricsQueryUnit/","text":"MetricsQueryUnit Object containing the metric unit family, scale factor, name, and short name. Properties Name Type Description Notes family str Unit family, allows for conversion between units of the same family, for scaling. optional name str Unit name optional plural str Plural form of the unit name. optional scale_factor float Factor for scaling between units of the same family. optional short_name str Abbreviation of the unit. optional [Back to Model list] [Back to API list] [Back to README]","title":"MetricsQueryUnit"},{"location":"v1/MetricsQueryUnit/#metricsqueryunit","text":"Object containing the metric unit family, scale factor, name, and short name.","title":"MetricsQueryUnit"},{"location":"v1/MetricsQueryUnit/#properties","text":"Name Type Description Notes family str Unit family, allows for conversion between units of the same family, for scaling. optional name str Unit name optional plural str Plural form of the unit name. optional scale_factor float Factor for scaling between units of the same family. optional short_name str Abbreviation of the unit. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Monitor/","text":"Monitor Object describing a monitor. Properties Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Monitor"},{"location":"v1/Monitor/#monitor","text":"Object describing a monitor.","title":"Monitor"},{"location":"v1/Monitor/#properties","text":"Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorDeviceID/","text":"MonitorDeviceID ID of the device the Synthetics monitor is running on. Same as SyntheticsDeviceID . Properties Name Type Description Notes value str ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorDeviceID"},{"location":"v1/MonitorDeviceID/#monitordeviceid","text":"ID of the device the Synthetics monitor is running on. Same as SyntheticsDeviceID .","title":"MonitorDeviceID"},{"location":"v1/MonitorDeviceID/#properties","text":"Name Type Description Notes value str ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorOptions/","text":"MonitorOptions List of options associated with your monitor. Properties Name Type Description Notes aggregation MonitorOptionsAggregation [optional] device_ids [MonitorDeviceID] IDs of the device the Synthetics monitor is running on. optional enable_logs_sample bool Whether or not to send a log sample when the log monitor triggers. [optional] escalation_message str A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. [optional] if omitted the server will use the default value of \"none\" evaluation_delay int, none_type 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 bool Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. [optional] include_tags bool 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] if omitted the server will use the default value of True locked bool Whether or not the monitor is locked (only editable by creator and admins). [optional] min_failure_duration int, none_type How long the test should be in failure before alerting (integer, number of seconds, max 7200). [optional] if omitted the server will use the default value of 0 min_location_failed int, none_type 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] if omitted the server will use the default value of 1 new_host_delay int, none_type 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. [optional] if omitted the server will use the default value of 300 no_data_timeframe int, none_type 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 bool A Boolean indicating whether tagged users is notified on changes to this monitor. [optional] if omitted the server will use the default value of False notify_no_data bool A Boolean indicating whether this monitor notifies when data stops reporting. [optional] if omitted the server will use the default value of False renotify_interval int, none_type The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it\u2019s not resolved. [optional] require_full_window bool A Boolean indicating whether this monitor needs a full window of data before it\u2019s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. [optional] silenced {str: (int, none_type)} Information about the downtime applied to the monitor. [optional] synthetics_check_id str, none_type ID of the corresponding Synthetic check. [optional] threshold_windows MonitorThresholdWindowOptions [optional] thresholds MonitorThresholds [optional] timeout_h int, none_type The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorOptions"},{"location":"v1/MonitorOptions/#monitoroptions","text":"List of options associated with your monitor.","title":"MonitorOptions"},{"location":"v1/MonitorOptions/#properties","text":"Name Type Description Notes aggregation MonitorOptionsAggregation [optional] device_ids [MonitorDeviceID] IDs of the device the Synthetics monitor is running on. optional enable_logs_sample bool Whether or not to send a log sample when the log monitor triggers. [optional] escalation_message str A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. [optional] if omitted the server will use the default value of \"none\" evaluation_delay int, none_type 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 bool Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. [optional] include_tags bool 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] if omitted the server will use the default value of True locked bool Whether or not the monitor is locked (only editable by creator and admins). [optional] min_failure_duration int, none_type How long the test should be in failure before alerting (integer, number of seconds, max 7200). [optional] if omitted the server will use the default value of 0 min_location_failed int, none_type 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] if omitted the server will use the default value of 1 new_host_delay int, none_type 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. [optional] if omitted the server will use the default value of 300 no_data_timeframe int, none_type 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 bool A Boolean indicating whether tagged users is notified on changes to this monitor. [optional] if omitted the server will use the default value of False notify_no_data bool A Boolean indicating whether this monitor notifies when data stops reporting. [optional] if omitted the server will use the default value of False renotify_interval int, none_type The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it\u2019s not resolved. [optional] require_full_window bool A Boolean indicating whether this monitor needs a full window of data before it\u2019s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. [optional] silenced {str: (int, none_type)} Information about the downtime applied to the monitor. [optional] synthetics_check_id str, none_type ID of the corresponding Synthetic check. [optional] threshold_windows MonitorThresholdWindowOptions [optional] thresholds MonitorThresholds [optional] timeout_h int, none_type The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorOptionsAggregation/","text":"MonitorOptionsAggregation Type of aggregation performed in the monitor query. Properties Name Type Description Notes group_by str Group to break down the monitor on. [optional] metric str Metric name used in the monitor. [optional] type str Metric type used in the monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorOptionsAggregation"},{"location":"v1/MonitorOptionsAggregation/#monitoroptionsaggregation","text":"Type of aggregation performed in the monitor query.","title":"MonitorOptionsAggregation"},{"location":"v1/MonitorOptionsAggregation/#properties","text":"Name Type Description Notes group_by str Group to break down the monitor on. [optional] metric str Metric name used in the monitor. [optional] type str Metric type used in the monitor. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorOverallStates/","text":"MonitorOverallStates The different states your monitor can be in. Properties Name Type Description Notes value str The different states your monitor can be in. must be one of [\"Alert\", \"Ignored\", \"No Data\", \"OK\", \"Skipped\", \"Unknown\", \"Warn\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorOverallStates"},{"location":"v1/MonitorOverallStates/#monitoroverallstates","text":"The different states your monitor can be in.","title":"MonitorOverallStates"},{"location":"v1/MonitorOverallStates/#properties","text":"Name Type Description Notes value str The different states your monitor can be in. must be one of [\"Alert\", \"Ignored\", \"No Data\", \"OK\", \"Skipped\", \"Unknown\", \"Warn\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorState/","text":"MonitorState Wrapper object with the different monitor states. Properties Name Type Description Notes groups {str: (MonitorStateGroup,)} 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] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorState"},{"location":"v1/MonitorState/#monitorstate","text":"Wrapper object with the different monitor states.","title":"MonitorState"},{"location":"v1/MonitorState/#properties","text":"Name Type Description Notes groups {str: (MonitorStateGroup,)} 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorStateGroup/","text":"MonitorStateGroup Monitor state for a single group. Properties Name Type Description Notes last_nodata_ts int Latest timestamp the monitor was in NO_DATA state. [optional] last_notified_ts int Latest timestamp of the notification sent for this monitor group. [optional] last_resolved_ts int Latest timestamp the monitor group was resolved. [optional] last_triggered_ts int Latest timestamp the monitor group triggered. [optional] name str The name of the monitor. [optional] status MonitorOverallStates [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorStateGroup"},{"location":"v1/MonitorStateGroup/#monitorstategroup","text":"Monitor state for a single group.","title":"MonitorStateGroup"},{"location":"v1/MonitorStateGroup/#properties","text":"Name Type Description Notes last_nodata_ts int Latest timestamp the monitor was in NO_DATA state. [optional] last_notified_ts int Latest timestamp of the notification sent for this monitor group. [optional] last_resolved_ts int Latest timestamp the monitor group was resolved. [optional] last_triggered_ts int Latest timestamp the monitor group triggered. [optional] name str The name of the monitor. [optional] status MonitorOverallStates [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorSummaryWidgetDefinition/","text":"MonitorSummaryWidgetDefinition The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards. Properties Name Type Description Notes query str Query to filter the monitors with. type MonitorSummaryWidgetDefinitionType color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetMonitorSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] sort WidgetMonitorSummarySort [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorSummaryWidgetDefinition"},{"location":"v1/MonitorSummaryWidgetDefinition/#monitorsummarywidgetdefinition","text":"The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.","title":"MonitorSummaryWidgetDefinition"},{"location":"v1/MonitorSummaryWidgetDefinition/#properties","text":"Name Type Description Notes query str Query to filter the monitors with. type MonitorSummaryWidgetDefinitionType color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetMonitorSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] sort WidgetMonitorSummarySort [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorSummaryWidgetDefinitionType/","text":"MonitorSummaryWidgetDefinitionType Type of the monitor summary widget. Properties Name Type Description Notes value str Type of the monitor summary widget. defaults to \"manage_status\", must be one of [\"manage_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorSummaryWidgetDefinitionType"},{"location":"v1/MonitorSummaryWidgetDefinitionType/#monitorsummarywidgetdefinitiontype","text":"Type of the monitor summary widget.","title":"MonitorSummaryWidgetDefinitionType"},{"location":"v1/MonitorSummaryWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the monitor summary widget. defaults to \"manage_status\", must be one of [\"manage_status\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorThresholdWindowOptions/","text":"MonitorThresholdWindowOptions Alerting time window options. Properties Name Type Description Notes recovery_window str, none_type Describes how long an anomalous metric must be normal before the alert recovers. [optional] trigger_window str, none_type Describes how long a metric must be anomalous before an alert triggers. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorThresholdWindowOptions"},{"location":"v1/MonitorThresholdWindowOptions/#monitorthresholdwindowoptions","text":"Alerting time window options.","title":"MonitorThresholdWindowOptions"},{"location":"v1/MonitorThresholdWindowOptions/#properties","text":"Name Type Description Notes recovery_window str, none_type Describes how long an anomalous metric must be normal before the alert recovers. [optional] trigger_window str, none_type Describes how long a metric must be anomalous before an alert triggers. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorThresholds/","text":"MonitorThresholds List of the different monitor threshold available. Properties Name Type Description Notes critical float The monitor `CRITICAL` threshold. [optional] critical_recovery float, none_type The monitor `CRITICAL` recovery threshold. [optional] ok float, none_type The monitor `OK` threshold. [optional] unknown float, none_type The monitor UNKNOWN threshold. [optional] warning float, none_type The monitor `WARNING` threshold. [optional] warning_recovery float, none_type The monitor `WARNING` recovery threshold. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorThresholds"},{"location":"v1/MonitorThresholds/#monitorthresholds","text":"List of the different monitor threshold available.","title":"MonitorThresholds"},{"location":"v1/MonitorThresholds/#properties","text":"Name Type Description Notes critical float The monitor `CRITICAL` threshold. [optional] critical_recovery float, none_type The monitor `CRITICAL` recovery threshold. [optional] ok float, none_type The monitor `OK` threshold. [optional] unknown float, none_type The monitor UNKNOWN threshold. [optional] warning float, none_type The monitor `WARNING` threshold. [optional] warning_recovery float, none_type The monitor `WARNING` recovery threshold. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorType/","text":"MonitorType The type of the monitor. For more information about type , see the monitor options docs. Properties Name Type Description Notes value str The type of the monitor. For more information about `type`, see the monitor options docs. must be one of [\"composite\", \"event alert\", \"log alert\", \"metric alert\", \"process alert\", \"query alert\", \"rum alert\", \"service check\", \"synthetics alert\", \"trace-analytics alert\", \"slo alert\", \"event-v2 alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorType"},{"location":"v1/MonitorType/#monitortype","text":"The type of the monitor. For more information about type , see the monitor options docs.","title":"MonitorType"},{"location":"v1/MonitorType/#properties","text":"Name Type Description Notes value str The type of the monitor. For more information about `type`, see the monitor options docs. must be one of [\"composite\", \"event alert\", \"log alert\", \"metric alert\", \"process alert\", \"query alert\", \"rum alert\", \"service check\", \"synthetics alert\", \"trace-analytics alert\", \"slo alert\", \"event-v2 alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorUpdateRequest/","text":"MonitorUpdateRequest Object describing a monitor update request. Properties Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MonitorUpdateRequest"},{"location":"v1/MonitorUpdateRequest/#monitorupdaterequest","text":"Object describing a monitor update request.","title":"MonitorUpdateRequest"},{"location":"v1/MonitorUpdateRequest/#properties","text":"Name Type Description Notes created datetime Timestamp of the monitor creation. optional creator Creator [optional] deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) optional id int ID of this monitor. optional message str A message to include with notifications for this monitor. [optional] modified datetime Last timestamp when the monitor was edited. optional multi bool Whether or not the monitor is broken down on different groups. optional name str The monitor name. [optional] options MonitorOptions [optional] overall_state MonitorOverallStates [optional] priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional] query str The monitor query. [optional] restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional] state MonitorState [optional] tags [str] Tags associated to your monitor. [optional] type MonitorType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/MonitorsApi/","text":"datadog_api_client.v1.MonitorsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted create_monitor POST /api/v1/monitor Create a monitor delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details list_monitors GET /api/v1/monitor Get all monitor details update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor validate_monitor POST /api/v1/monitor/validate Validate a monitor check_can_delete_monitor CheckCanDeleteMonitorResponse check_can_delete_monitor(monitor_ids) Check if a monitor can be deleted Check if the given monitors can be deleted. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_ids = [ 1, ] # [int] | The IDs of the monitor to check. # example passing only required values which don't have defaults set try: # Check if a monitor can be deleted api_response = api_instance.check_can_delete_monitor(monitor_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->check_can_delete_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_ids [int] The IDs of the monitor to check. Return type CheckCanDeleteMonitorResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Deletion conflict error - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_monitor Monitor create_monitor(body) Create a monitor Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: query alert - APM: query alert or trace-analytics alert - composite: composite - custom: service check - event: event alert - forecast: query alert - host: service check - integration: query alert or service check - live process: process alert - logs: log alert - metric: metric alert - network: service check - outlier: query alert - process: service check - rum: rum alert - SLO: slo alert - watchdog: event alert - event-v2: event-v2 alert #### Query Types Metric Alert Query 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 2880 depending on the monitor type) or last_#h (with # between 1 and 48 depending on the monitor type), or last_1d - space_aggr : avg, sum, min, or max - 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: - change_aggr change, pct_change - time_aggr avg, sum, max, min Learn more - 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: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0 Service Check Query Example: \\\"check\\\".over(tags).last(count).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\\\") - 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 3. Event Alert Query Example: events('sources:nagios status:error,warning priority:normal tags: \\\"string query\\\"').rollup(\\\"count\\\").last(\\\"1h\\\")\\\" - event , the event query string: - string_query free text query to match against event title and text. - sources event sources (comma-separated). - status event statuses (comma-separated). Valid options: error, warn, and info. - priority event priorities (comma-separated). Valid options: low, normal, all. - host event reporting host (comma-separated). - tags event tags (comma-separated). - excluded_tags excluded event tags (comma-separated). - rollup the stats roll-up method. count is the only supported method now. - last the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. NOTE Only available on US1 and EU. Event V2 Alert Query Example: events(query).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. NOTE Only available on US1-FED, US3, and in closed beta on EU and US1. Process Alert Query 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 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 != - # an integer or decimal number used to set the threshold Logs Alert Query Example: logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - index_name For multi-index organizations, the log index in which the request is performed. - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48) - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. Composite Query 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. SLO Alert Query Example: error_budget(\\\"slo_id\\\").over(\\\"time_window\\\") operator # - slo_id : The alphanumeric SLO ID of the SLO you are configuring the alert for. - time_window : The time window of the SLO target you wish to alert on. Valid options: 7d , 30d , 90d . - operator *: >= or > Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Create a monitor request body. # example passing only required values which don't have defaults set try: # Create a monitor api_response = api_instance.create_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->create_monitor: %s\\n\" % e) Parameters Name Type Description Notes body Monitor Create a monitor request body. Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_monitor DeletedMonitor delete_monitor(monitor_id) Delete a monitor Delete the specified monitor Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The ID of the monitor. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional] Return type DeletedMonitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Item not found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_monitor Monitor get_monitor(monitor_id) Get a monitor's details Get details about the specified monitor from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) # example passing only required values which don't have defaults set try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id, group_states=group_states) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The ID of the monitor group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional] Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_monitors [Monitor] list_monitors() Get all monitor details Get details about the specified monitor from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) name = \"name_example\" # str | A string to filter monitors by name. (optional) tags = \"tags_example\" # str | 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 = \"monitor_tags_example\" # str | 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 = True # bool | If this argument is set to true, then the returned data includes all current downtimes for each monitor. (optional) id_offset = 1 # int | Monitor ID offset. (optional) page = 1 # int | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. (optional) page_size = 1 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # Get all monitor details api_response = api_instance.list_monitors(group_states=group_states, name=name, tags=tags, monitor_tags=monitor_tags, with_downtimes=with_downtimes, id_offset=id_offset, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->list_monitors: %s\\n\" % e) Parameters Name Type Description Notes group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional] name str A string to filter monitors by name. [optional] tags str 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 str 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 bool If this argument is set to true, then the returned data includes all current downtimes for each monitor. [optional] id_offset int Monitor ID offset. [optional] page int The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. [optional] page_size int 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 [Monitor] Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_monitor Monitor update_monitor(monitor_id, body) Edit a monitor Edit the specified monitor. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. body = MonitorUpdateRequest( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # MonitorUpdateRequest | Edit a monitor request body. # example passing only required values which don't have defaults set try: # Edit a monitor api_response = api_instance.update_monitor(monitor_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->update_monitor: %s\\n\" % e) Parameters Name Type Description Notes monitor_id int The ID of the monitor. body MonitorUpdateRequest Edit a monitor request body. Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README] validate_monitor Monitor validate_monitor(body) Validate a monitor Validate the monitor provided in the request. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Monitor request object # example passing only required values which don't have defaults set try: # Validate a monitor api_response = api_instance.validate_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->validate_monitor: %s\\n\" % e) Parameters Name Type Description Notes body Monitor Monitor request object Return type Monitor Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid JSON - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.MonitorsApi"},{"location":"v1/MonitorsApi/#datadog_api_clientv1monitorsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_monitor GET /api/v1/monitor/can_delete Check if a monitor can be deleted create_monitor POST /api/v1/monitor Create a monitor delete_monitor DELETE /api/v1/monitor/{monitor_id} Delete a monitor get_monitor GET /api/v1/monitor/{monitor_id} Get a monitor's details list_monitors GET /api/v1/monitor Get all monitor details update_monitor PUT /api/v1/monitor/{monitor_id} Edit a monitor validate_monitor POST /api/v1/monitor/validate Validate a monitor","title":"datadog_api_client.v1.MonitorsApi"},{"location":"v1/MonitorsApi/#check_can_delete_monitor","text":"CheckCanDeleteMonitorResponse check_can_delete_monitor(monitor_ids) Check if a monitor can be deleted Check if the given monitors can be deleted.","title":"check_can_delete_monitor"},{"location":"v1/MonitorsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_ids = [ 1, ] # [int] | The IDs of the monitor to check. # example passing only required values which don't have defaults set try: # Check if a monitor can be deleted api_response = api_instance.check_can_delete_monitor(monitor_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->check_can_delete_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters","text":"Name Type Description Notes monitor_ids [int] The IDs of the monitor to check.","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type","text":"CheckCanDeleteMonitorResponse","title":"Return type"},{"location":"v1/MonitorsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Deletion conflict error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#create_monitor","text":"Monitor create_monitor(body) Create a monitor Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: query alert - APM: query alert or trace-analytics alert - composite: composite - custom: service check - event: event alert - forecast: query alert - host: service check - integration: query alert or service check - live process: process alert - logs: log alert - metric: metric alert - network: service check - outlier: query alert - process: service check - rum: rum alert - SLO: slo alert - watchdog: event alert - event-v2: event-v2 alert #### Query Types Metric Alert Query 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 2880 depending on the monitor type) or last_#h (with # between 1 and 48 depending on the monitor type), or last_1d - space_aggr : avg, sum, min, or max - 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: - change_aggr change, pct_change - time_aggr avg, sum, max, min Learn more - 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: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0 Service Check Query Example: \\\"check\\\".over(tags).last(count).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\\\") - 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 3. Event Alert Query Example: events('sources:nagios status:error,warning priority:normal tags: \\\"string query\\\"').rollup(\\\"count\\\").last(\\\"1h\\\")\\\" - event , the event query string: - string_query free text query to match against event title and text. - sources event sources (comma-separated). - status event statuses (comma-separated). Valid options: error, warn, and info. - priority event priorities (comma-separated). Valid options: low, normal, all. - host event reporting host (comma-separated). - tags event tags (comma-separated). - excluded_tags excluded event tags (comma-separated). - rollup the stats roll-up method. count is the only supported method now. - last the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. NOTE Only available on US1 and EU. Event V2 Alert Query Example: events(query).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. NOTE Only available on US1-FED, US3, and in closed beta on EU and US1. Process Alert Query 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 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 != - # an integer or decimal number used to set the threshold Logs Alert Query Example: logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax . - index_name For multi-index organizations, the log index in which the request is performed. - rollup_method The stats roll-up method - supports count , avg and cardinality . - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48) - operator < , <= , > , >= , == , or != . - # an integer or decimal number used to set the threshold. Composite Query 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. SLO Alert Query Example: error_budget(\\\"slo_id\\\").over(\\\"time_window\\\") operator # - slo_id : The alphanumeric SLO ID of the SLO you are configuring the alert for. - time_window : The time window of the SLO target you wish to alert on. Valid options: 7d , 30d , 90d . - operator *: >= or >","title":"create_monitor"},{"location":"v1/MonitorsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Create a monitor request body. # example passing only required values which don't have defaults set try: # Create a monitor api_response = api_instance.create_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->create_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_1","text":"Name Type Description Notes body Monitor Create a monitor request body.","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_1","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#delete_monitor","text":"DeletedMonitor delete_monitor(monitor_id) Delete a monitor Delete the specified monitor","title":"delete_monitor"},{"location":"v1/MonitorsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete a monitor api_response = api_instance.delete_monitor(monitor_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->delete_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_2","text":"Name Type Description Notes monitor_id int The ID of the monitor. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional]","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_2","text":"DeletedMonitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Item not found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#get_monitor","text":"Monitor get_monitor(monitor_id) Get a monitor's details Get details about the specified monitor from your organization.","title":"get_monitor"},{"location":"v1/MonitorsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) # example passing only required values which don't have defaults set try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a monitor's details api_response = api_instance.get_monitor(monitor_id, group_states=group_states) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->get_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_3","text":"Name Type Description Notes monitor_id int The ID of the monitor group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional]","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_3","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#list_monitors","text":"[Monitor] list_monitors() Get all monitor details Get details about the specified monitor from your organization.","title":"list_monitors"},{"location":"v1/MonitorsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) group_states = \"group_states_example\" # str | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. (optional) name = \"name_example\" # str | A string to filter monitors by name. (optional) tags = \"tags_example\" # str | 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 = \"monitor_tags_example\" # str | 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 = True # bool | If this argument is set to true, then the returned data includes all current downtimes for each monitor. (optional) id_offset = 1 # int | Monitor ID offset. (optional) page = 1 # int | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. (optional) page_size = 1 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # Get all monitor details api_response = api_instance.list_monitors(group_states=group_states, name=name, tags=tags, monitor_tags=monitor_tags, with_downtimes=with_downtimes, id_offset=id_offset, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->list_monitors: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_4","text":"Name Type Description Notes group_states str When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. [optional] name str A string to filter monitors by name. [optional] tags str 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 str 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 bool If this argument is set to true, then the returned data includes all current downtimes for each monitor. [optional] id_offset int Monitor ID offset. [optional] page int The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. [optional] page_size int 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]","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_4","text":"[Monitor]","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#update_monitor","text":"Monitor update_monitor(monitor_id, body) Edit a monitor Edit the specified monitor.","title":"update_monitor"},{"location":"v1/MonitorsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) monitor_id = 1 # int | The ID of the monitor. body = MonitorUpdateRequest( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # MonitorUpdateRequest | Edit a monitor request body. # example passing only required values which don't have defaults set try: # Edit a monitor api_response = api_instance.update_monitor(monitor_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->update_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_5","text":"Name Type Description Notes monitor_id int The ID of the monitor. body MonitorUpdateRequest Edit a monitor request body.","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_5","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Authentication error - 403 Forbidden - 404 Monitor Not Found error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/MonitorsApi/#validate_monitor","text":"Monitor validate_monitor(body) Validate a monitor Validate the monitor provided in the request.","title":"validate_monitor"},{"location":"v1/MonitorsApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import monitors_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitors_api.MonitorsApi(api_client) body = Monitor( created=dateutil_parser('1970-01-01T00:00:00.00Z'), creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), deleted=dateutil_parser('1970-01-01T00:00:00.00Z'), id=1, message=\"message_example\", modified=dateutil_parser('1970-01-01T00:00:00.00Z'), multi=True, name=\"name_example\", options=MonitorOptions( aggregation=MonitorOptionsAggregation( group_by=\"host\", metric=\"metrics.name\", type=\"count\", ), device_ids=[ MonitorDeviceID(\"laptop_large\"), ], enable_logs_sample=True, escalation_message=\"none\", evaluation_delay=1, groupby_simple_monitor=True, include_tags=True, locked=True, min_failure_duration=0, min_location_failed=1, new_host_delay=300, no_data_timeframe=1, notify_audit=False, notify_no_data=False, renotify_interval=1, require_full_window=True, silenced={ \"key\": 1, }, synthetics_check_id=\"synthetics_check_id_example\", threshold_windows=MonitorThresholdWindowOptions( recovery_window=\"recovery_window_example\", trigger_window=\"trigger_window_example\", ), thresholds=MonitorThresholds( critical=3.14, critical_recovery=3.14, ok=3.14, unknown=3.14, warning=3.14, warning_recovery=3.14, ), timeout_h=1, ), overall_state=MonitorOverallStates(\"Alert\"), priority=1, query=\"query_example\", restricted_roles=[ \"restricted_roles_example\", ], state=MonitorState( groups={ \"key\": MonitorStateGroup( last_nodata_ts=1, last_notified_ts=1, last_resolved_ts=1, last_triggered_ts=1, name=\"name_example\", status=MonitorOverallStates(\"Alert\"), ), }, ), tags=[ \"tags_example\", ], type=MonitorType(\"composite\"), ) # Monitor | Monitor request object # example passing only required values which don't have defaults set try: # Validate a monitor api_response = api_instance.validate_monitor(body) pprint(api_response) except ApiException as e: print(\"Exception when calling MonitorsApi->validate_monitor: %s\\n\" % e)","title":"Example"},{"location":"v1/MonitorsApi/#parameters_6","text":"Name Type Description Notes body Monitor Monitor request object","title":"Parameters"},{"location":"v1/MonitorsApi/#return-type_6","text":"Monitor","title":"Return type"},{"location":"v1/MonitorsApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/MonitorsApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/MonitorsApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Invalid JSON - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/NoteWidgetDefinition/","text":"NoteWidgetDefinition The notes and links widget is similar to free text widget, but allows for more formatting options. Properties Name Type Description Notes content str Content of the note. type NoteWidgetDefinitionType background_color str Background color of the note. [optional] font_size str Size of the text. [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] text_align WidgetTextAlign [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"NoteWidgetDefinition"},{"location":"v1/NoteWidgetDefinition/#notewidgetdefinition","text":"The notes and links widget is similar to free text widget, but allows for more formatting options.","title":"NoteWidgetDefinition"},{"location":"v1/NoteWidgetDefinition/#properties","text":"Name Type Description Notes content str Content of the note. type NoteWidgetDefinitionType background_color str Background color of the note. [optional] font_size str Size of the text. [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] text_align WidgetTextAlign [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] vertical_align WidgetVerticalAlign [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/NoteWidgetDefinitionType/","text":"NoteWidgetDefinitionType Type of the note widget. Properties Name Type Description Notes value str Type of the note widget. defaults to \"note\", must be one of [\"note\", ] [Back to Model list] [Back to API list] [Back to README]","title":"NoteWidgetDefinitionType"},{"location":"v1/NoteWidgetDefinitionType/#notewidgetdefinitiontype","text":"Type of the note widget.","title":"NoteWidgetDefinitionType"},{"location":"v1/NoteWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the note widget. defaults to \"note\", must be one of [\"note\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Organization/","text":"Organization Create, edit, and manage organizations. Properties Name Type Description Notes billing OrganizationBilling [optional] created str Date of the organization creation. optional description str Description of the organization. [optional] name str The name of the new child-organization, limited to 32 characters. [optional] public_id str The `public_id` of the organization you are operating within. [optional] settings OrganizationSettings [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Organization"},{"location":"v1/Organization/#organization","text":"Create, edit, and manage organizations.","title":"Organization"},{"location":"v1/Organization/#properties","text":"Name Type Description Notes billing OrganizationBilling [optional] created str Date of the organization creation. optional description str Description of the organization. [optional] name str The name of the new child-organization, limited to 32 characters. [optional] public_id str The `public_id` of the organization you are operating within. [optional] settings OrganizationSettings [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationBilling/","text":"OrganizationBilling A JSON array of billing type. Properties Name Type Description Notes type str The type of billing. Only `parent_billing` is supported. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationBilling"},{"location":"v1/OrganizationBilling/#organizationbilling","text":"A JSON array of billing type.","title":"OrganizationBilling"},{"location":"v1/OrganizationBilling/#properties","text":"Name Type Description Notes type str The type of billing. Only `parent_billing` is supported. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationCreateBody/","text":"OrganizationCreateBody Object describing an organization to create. Properties Name Type Description Notes name str The name of the new child-organization, limited to 32 characters. billing OrganizationBilling [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationCreateBody"},{"location":"v1/OrganizationCreateBody/#organizationcreatebody","text":"Object describing an organization to create.","title":"OrganizationCreateBody"},{"location":"v1/OrganizationCreateBody/#properties","text":"Name Type Description Notes name str The name of the new child-organization, limited to 32 characters. billing OrganizationBilling [optional] subscription OrganizationSubscription [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationCreateResponse/","text":"OrganizationCreateResponse Response object for an organization creation. Properties Name Type Description Notes api_key ApiKey [optional] application_key ApplicationKey [optional] org Organization [optional] user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationCreateResponse"},{"location":"v1/OrganizationCreateResponse/#organizationcreateresponse","text":"Response object for an organization creation.","title":"OrganizationCreateResponse"},{"location":"v1/OrganizationCreateResponse/#properties","text":"Name Type Description Notes api_key ApiKey [optional] application_key ApplicationKey [optional] org Organization [optional] user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationListResponse/","text":"OrganizationListResponse Response with the list of organizations. Properties Name Type Description Notes orgs [Organization] Array of organization objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationListResponse"},{"location":"v1/OrganizationListResponse/#organizationlistresponse","text":"Response with the list of organizations.","title":"OrganizationListResponse"},{"location":"v1/OrganizationListResponse/#properties","text":"Name Type Description Notes orgs [Organization] Array of organization objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationResponse/","text":"OrganizationResponse Response with an organization. Properties Name Type Description Notes org Organization [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationResponse"},{"location":"v1/OrganizationResponse/#organizationresponse","text":"Response with an organization.","title":"OrganizationResponse"},{"location":"v1/OrganizationResponse/#properties","text":"Name Type Description Notes org Organization [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettings/","text":"OrganizationSettings A JSON array of settings. Properties Name Type Description Notes private_widget_share bool Whether or not the organization users can share widgets outside of Datadog. [optional] saml OrganizationSettingsSaml [optional] saml_autocreate_access_role AccessRole [optional] saml_autocreate_users_domains OrganizationSettingsSamlAutocreateUsersDomains [optional] saml_can_be_enabled bool Whether or not SAML can be enabled for this organization. [optional] saml_idp_endpoint str Identity provider endpoint for SAML authentication. [optional] saml_idp_initiated_login OrganizationSettingsSamlIdpInitiatedLogin [optional] saml_idp_metadata_uploaded bool Whether or not a SAML identity provider metadata file was provided to the Datadog organization. [optional] saml_login_url str URL for SAML logging. [optional] saml_strict_mode OrganizationSettingsSamlStrictMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettings"},{"location":"v1/OrganizationSettings/#organizationsettings","text":"A JSON array of settings.","title":"OrganizationSettings"},{"location":"v1/OrganizationSettings/#properties","text":"Name Type Description Notes private_widget_share bool Whether or not the organization users can share widgets outside of Datadog. [optional] saml OrganizationSettingsSaml [optional] saml_autocreate_access_role AccessRole [optional] saml_autocreate_users_domains OrganizationSettingsSamlAutocreateUsersDomains [optional] saml_can_be_enabled bool Whether or not SAML can be enabled for this organization. [optional] saml_idp_endpoint str Identity provider endpoint for SAML authentication. [optional] saml_idp_initiated_login OrganizationSettingsSamlIdpInitiatedLogin [optional] saml_idp_metadata_uploaded bool Whether or not a SAML identity provider metadata file was provided to the Datadog organization. [optional] saml_login_url str URL for SAML logging. [optional] saml_strict_mode OrganizationSettingsSamlStrictMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSaml/","text":"OrganizationSettingsSaml Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings. Properties Name Type Description Notes enabled bool Whether or not SAML is enabled for this organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSaml"},{"location":"v1/OrganizationSettingsSaml/#organizationsettingssaml","text":"Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.","title":"OrganizationSettingsSaml"},{"location":"v1/OrganizationSettingsSaml/#properties","text":"Name Type Description Notes enabled bool Whether or not SAML is enabled for this organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSamlAutocreateUsersDomains/","text":"OrganizationSettingsSamlAutocreateUsersDomains Has two properties, enabled (boolean) and domains , which is a list of domains without the @ symbol. Properties Name Type Description Notes domains [str] List of domains where the SAML automated user creation is enabled. [optional] enabled bool Whether or not the automated user creation based on SAML domain is enabled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSamlAutocreateUsersDomains"},{"location":"v1/OrganizationSettingsSamlAutocreateUsersDomains/#organizationsettingssamlautocreateusersdomains","text":"Has two properties, enabled (boolean) and domains , which is a list of domains without the @ symbol.","title":"OrganizationSettingsSamlAutocreateUsersDomains"},{"location":"v1/OrganizationSettingsSamlAutocreateUsersDomains/#properties","text":"Name Type Description Notes domains [str] List of domains where the SAML automated user creation is enabled. [optional] enabled bool Whether or not the automated user creation based on SAML domain is enabled. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSamlIdpInitiatedLogin/","text":"OrganizationSettingsSamlIdpInitiatedLogin Has one property enabled (boolean). Properties Name Type Description Notes enabled bool Whether SAML IdP initiated login is enabled, learn more in the SAML documentation . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSamlIdpInitiatedLogin"},{"location":"v1/OrganizationSettingsSamlIdpInitiatedLogin/#organizationsettingssamlidpinitiatedlogin","text":"Has one property enabled (boolean).","title":"OrganizationSettingsSamlIdpInitiatedLogin"},{"location":"v1/OrganizationSettingsSamlIdpInitiatedLogin/#properties","text":"Name Type Description Notes enabled bool Whether SAML IdP initiated login is enabled, learn more in the SAML documentation . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSettingsSamlStrictMode/","text":"OrganizationSettingsSamlStrictMode Has one property enabled (boolean). Properties Name Type Description Notes enabled bool 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSettingsSamlStrictMode"},{"location":"v1/OrganizationSettingsSamlStrictMode/#organizationsettingssamlstrictmode","text":"Has one property enabled (boolean).","title":"OrganizationSettingsSamlStrictMode"},{"location":"v1/OrganizationSettingsSamlStrictMode/#properties","text":"Name Type Description Notes enabled bool 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 . [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationSubscription/","text":"OrganizationSubscription Subscription definition. Properties Name Type Description Notes type str The subscription type. Types available are `trial`, `free`, and `pro`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationSubscription"},{"location":"v1/OrganizationSubscription/#organizationsubscription","text":"Subscription definition.","title":"OrganizationSubscription"},{"location":"v1/OrganizationSubscription/#properties","text":"Name Type Description Notes type str The subscription type. Types available are `trial`, `free`, and `pro`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/OrganizationsApi/","text":"datadog_api_client.v1.OrganizationsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_child_org POST /api/v1/org Create a child organization get_org GET /api/v1/org/{public_id} Get organization information list_orgs GET /api/v1/org List your managed organizations update_org PUT /api/v1/org/{public_id} Update your organization upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata create_child_org OrganizationCreateResponse create_child_org(body) Create a child organization Create a child organization. This endpoint requires the multi-organization account feature and must be enabled by contacting support . Once a new child organization is created, you can interact with it by using the org.public_id , pi_key.key , and application_key.hash provided in the response. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) body = OrganizationCreateBody( billing=OrganizationBilling( type=\"type_example\", ), name=\"New child org\", subscription=OrganizationSubscription( type=\"type_example\", ), ) # OrganizationCreateBody | Organization object that needs to be created # example passing only required values which don't have defaults set try: # Create a child organization api_response = api_instance.create_child_org(body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->create_child_org: %s\\n\" % e) Parameters Name Type Description Notes body OrganizationCreateBody Organization object that needs to be created Return type OrganizationCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_org OrganizationResponse get_org(public_id) Get organization information Get organization information. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. # example passing only required values which don't have defaults set try: # Get organization information api_response = api_instance.get_org(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->get_org: %s\\n\" % e) Parameters Name Type Description Notes public_id str The `public_id` of the organization you are operating within. Return type OrganizationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_orgs OrganizationListResponse list_orgs() List your managed organizations List your managed organizations. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) # example, this endpoint has no required or optional parameters try: # List your managed organizations api_response = api_instance.list_orgs() pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->list_orgs: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type OrganizationListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_org OrganizationResponse update_org(public_id, body) Update your organization Update your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. body = Organization( billing=OrganizationBilling( type=\"type_example\", ), created=\"2019-09-26T17:28:28Z\", description=\"some description\", name=\"New child org\", public_id=\"abcdef12345\", settings=OrganizationSettings( private_widget_share=False, saml=OrganizationSettingsSaml( enabled=False, ), saml_autocreate_access_role=AccessRole(\"st\"), saml_autocreate_users_domains=OrganizationSettingsSamlAutocreateUsersDomains( domains=[ \"example.com\", ], enabled=False, ), saml_can_be_enabled=False, saml_idp_endpoint=\"https://my.saml.endpoint\", saml_idp_initiated_login=OrganizationSettingsSamlIdpInitiatedLogin( enabled=False, ), saml_idp_metadata_uploaded=False, saml_login_url=\"https://my.saml.login.url\", saml_strict_mode=OrganizationSettingsSamlStrictMode( enabled=False, ), ), subscription=OrganizationSubscription( type=\"type_example\", ), ) # Organization | # example passing only required values which don't have defaults set try: # Update your organization api_response = api_instance.update_org(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->update_org: %s\\n\" % e) Parameters Name Type Description Notes public_id str The `public_id` of the organization you are operating within. body Organization Return type OrganizationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] upload_id_p_for_org IdpResponse upload_id_p_for_org(public_id, idp_file) Upload IdP metadata 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. * XML Body: Post the IdP metadata file as the body of the request. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating with idp_file = open('/path/to/file', 'rb') # file_type | The path to the XML metadata file you wish to upload. # example passing only required values which don't have defaults set try: # Upload IdP metadata api_response = api_instance.upload_id_p_for_org(public_id, idp_file) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->upload_id_p_for_org: %s\\n\" % e) Parameters Name Type Description Notes public_id str The `public_id` of the organization you are operating with idp_file file_type The path to the XML metadata file you wish to upload. Return type IdpResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : multipart/form-data Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 415 Unsupported Media Type - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.OrganizationsApi"},{"location":"v1/OrganizationsApi/#datadog_api_clientv1organizationsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_child_org POST /api/v1/org Create a child organization get_org GET /api/v1/org/{public_id} Get organization information list_orgs GET /api/v1/org List your managed organizations update_org PUT /api/v1/org/{public_id} Update your organization upload_id_p_for_org POST /api/v1/org/{public_id}/idp_metadata Upload IdP metadata","title":"datadog_api_client.v1.OrganizationsApi"},{"location":"v1/OrganizationsApi/#create_child_org","text":"OrganizationCreateResponse create_child_org(body) Create a child organization Create a child organization. This endpoint requires the multi-organization account feature and must be enabled by contacting support . Once a new child organization is created, you can interact with it by using the org.public_id , pi_key.key , and application_key.hash provided in the response.","title":"create_child_org"},{"location":"v1/OrganizationsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) body = OrganizationCreateBody( billing=OrganizationBilling( type=\"type_example\", ), name=\"New child org\", subscription=OrganizationSubscription( type=\"type_example\", ), ) # OrganizationCreateBody | Organization object that needs to be created # example passing only required values which don't have defaults set try: # Create a child organization api_response = api_instance.create_child_org(body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->create_child_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters","text":"Name Type Description Notes body OrganizationCreateBody Organization object that needs to be created","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type","text":"OrganizationCreateResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#get_org","text":"OrganizationResponse get_org(public_id) Get organization information Get organization information.","title":"get_org"},{"location":"v1/OrganizationsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. # example passing only required values which don't have defaults set try: # Get organization information api_response = api_instance.get_org(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->get_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_1","text":"Name Type Description Notes public_id str The `public_id` of the organization you are operating within.","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_1","text":"OrganizationResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#list_orgs","text":"OrganizationListResponse list_orgs() List your managed organizations List your managed organizations.","title":"list_orgs"},{"location":"v1/OrganizationsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) # example, this endpoint has no required or optional parameters try: # List your managed organizations api_response = api_instance.list_orgs() pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->list_orgs: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_2","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_2","text":"OrganizationListResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#update_org","text":"OrganizationResponse update_org(public_id, body) Update your organization Update your organization.","title":"update_org"},{"location":"v1/OrganizationsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating within. body = Organization( billing=OrganizationBilling( type=\"type_example\", ), created=\"2019-09-26T17:28:28Z\", description=\"some description\", name=\"New child org\", public_id=\"abcdef12345\", settings=OrganizationSettings( private_widget_share=False, saml=OrganizationSettingsSaml( enabled=False, ), saml_autocreate_access_role=AccessRole(\"st\"), saml_autocreate_users_domains=OrganizationSettingsSamlAutocreateUsersDomains( domains=[ \"example.com\", ], enabled=False, ), saml_can_be_enabled=False, saml_idp_endpoint=\"https://my.saml.endpoint\", saml_idp_initiated_login=OrganizationSettingsSamlIdpInitiatedLogin( enabled=False, ), saml_idp_metadata_uploaded=False, saml_login_url=\"https://my.saml.login.url\", saml_strict_mode=OrganizationSettingsSamlStrictMode( enabled=False, ), ), subscription=OrganizationSubscription( type=\"type_example\", ), ) # Organization | # example passing only required values which don't have defaults set try: # Update your organization api_response = api_instance.update_org(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->update_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_3","text":"Name Type Description Notes public_id str The `public_id` of the organization you are operating within. body Organization","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_3","text":"OrganizationResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/OrganizationsApi/#upload_id_p_for_org","text":"IdpResponse upload_id_p_for_org(public_id, idp_file) Upload IdP metadata 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. * XML Body: Post the IdP metadata file as the body of the request.","title":"upload_id_p_for_org"},{"location":"v1/OrganizationsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import organizations_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = organizations_api.OrganizationsApi(api_client) public_id = \"abc123\" # str | The `public_id` of the organization you are operating with idp_file = open('/path/to/file', 'rb') # file_type | The path to the XML metadata file you wish to upload. # example passing only required values which don't have defaults set try: # Upload IdP metadata api_response = api_instance.upload_id_p_for_org(public_id, idp_file) pprint(api_response) except ApiException as e: print(\"Exception when calling OrganizationsApi->upload_id_p_for_org: %s\\n\" % e)","title":"Example"},{"location":"v1/OrganizationsApi/#parameters_4","text":"Name Type Description Notes public_id str The `public_id` of the organization you are operating with idp_file file_type The path to the XML metadata file you wish to upload.","title":"Parameters"},{"location":"v1/OrganizationsApi/#return-type_4","text":"IdpResponse","title":"Return type"},{"location":"v1/OrganizationsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/OrganizationsApi/#http-request-headers_4","text":"Content-Type : multipart/form-data Accept : application/json","title":"HTTP request headers"},{"location":"v1/OrganizationsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 415 Unsupported Media Type - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/","text":"datadog_api_client.v1.PagerDutyIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object create_pager_duty_integration_service PagerDutyServiceName create_pager_duty_integration_service(body) Create a new service object Create a new service object in the PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) body = PagerDutyService( service_key=\"\", service_name=\"\", ) # PagerDutyService | Create a new service object request body. # example passing only required values which don't have defaults set try: # Create a new service object api_response = api_instance.create_pager_duty_integration_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->create_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes body PagerDutyService Create a new service object request body. Return type PagerDutyServiceName Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_pager_duty_integration_service delete_pager_duty_integration_service(service_name) Delete a single service object Delete a single service object in the Datadog-PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name # example passing only required values which don't have defaults set try: # Delete a single service object api_instance.delete_pager_duty_integration_service(service_name) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->delete_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes service_name str The service name Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_pager_duty_integration_service PagerDutyServiceName get_pager_duty_integration_service(service_name) Get a single service object Get service name in the Datadog-PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name. # example passing only required values which don't have defaults set try: # Get a single service object api_response = api_instance.get_pager_duty_integration_service(service_name) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->get_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes service_name str The service name. Return type PagerDutyServiceName Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_pager_duty_integration_service update_pager_duty_integration_service(service_name, body) Update a single service object Update a single service object in the Datadog-PagerDuty integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name body = PagerDutyServiceKey( service_key=\"\", ) # PagerDutyServiceKey | Update an existing service object request body. # example passing only required values which don't have defaults set try: # Update a single service object api_instance.update_pager_duty_integration_service(service_name, body) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->update_pager_duty_integration_service: %s\\n\" % e) Parameters Name Type Description Notes service_name str The service name body PagerDutyServiceKey Update an existing service object request body. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.PagerDutyIntegrationApi"},{"location":"v1/PagerDutyIntegrationApi/#datadog_api_clientv1pagerdutyintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_pager_duty_integration_service POST /api/v1/integration/pagerduty/configuration/services Create a new service object delete_pager_duty_integration_service DELETE /api/v1/integration/pagerduty/configuration/services/{service_name} Delete a single service object get_pager_duty_integration_service GET /api/v1/integration/pagerduty/configuration/services/{service_name} Get a single service object update_pager_duty_integration_service PUT /api/v1/integration/pagerduty/configuration/services/{service_name} Update a single service object","title":"datadog_api_client.v1.PagerDutyIntegrationApi"},{"location":"v1/PagerDutyIntegrationApi/#create_pager_duty_integration_service","text":"PagerDutyServiceName create_pager_duty_integration_service(body) Create a new service object Create a new service object in the PagerDuty integration.","title":"create_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) body = PagerDutyService( service_key=\"\", service_name=\"\", ) # PagerDutyService | Create a new service object request body. # example passing only required values which don't have defaults set try: # Create a new service object api_response = api_instance.create_pager_duty_integration_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->create_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters","text":"Name Type Description Notes body PagerDutyService Create a new service object request body.","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type","text":"PagerDutyServiceName","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details","text":"Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/#delete_pager_duty_integration_service","text":"delete_pager_duty_integration_service(service_name) Delete a single service object Delete a single service object in the Datadog-PagerDuty integration.","title":"delete_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name # example passing only required values which don't have defaults set try: # Delete a single service object api_instance.delete_pager_duty_integration_service(service_name) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->delete_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters_1","text":"Name Type Description Notes service_name str The service name","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/#get_pager_duty_integration_service","text":"PagerDutyServiceName get_pager_duty_integration_service(service_name) Get a single service object Get service name in the Datadog-PagerDuty integration.","title":"get_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name. # example passing only required values which don't have defaults set try: # Get a single service object api_response = api_instance.get_pager_duty_integration_service(service_name) pprint(api_response) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->get_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters_2","text":"Name Type Description Notes service_name str The service name.","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type_2","text":"PagerDutyServiceName","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyIntegrationApi/#update_pager_duty_integration_service","text":"update_pager_duty_integration_service(service_name, body) Update a single service object Update a single service object in the Datadog-PagerDuty integration.","title":"update_pager_duty_integration_service"},{"location":"v1/PagerDutyIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import pager_duty_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = pager_duty_integration_api.PagerDutyIntegrationApi(api_client) service_name = \"service_name_example\" # str | The service name body = PagerDutyServiceKey( service_key=\"\", ) # PagerDutyServiceKey | Update an existing service object request body. # example passing only required values which don't have defaults set try: # Update a single service object api_instance.update_pager_duty_integration_service(service_name, body) except ApiException as e: print(\"Exception when calling PagerDutyIntegrationApi->update_pager_duty_integration_service: %s\\n\" % e)","title":"Example"},{"location":"v1/PagerDutyIntegrationApi/#parameters_3","text":"Name Type Description Notes service_name str The service name body PagerDutyServiceKey Update an existing service object request body.","title":"Parameters"},{"location":"v1/PagerDutyIntegrationApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v1/PagerDutyIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/PagerDutyIntegrationApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/PagerDutyIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/PagerDutyService/","text":"PagerDutyService The PagerDuty service that is available for integration with Datadog. Properties Name Type Description Notes service_key str Your service key in PagerDuty. service_name str Your service name associated with a service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"PagerDutyService"},{"location":"v1/PagerDutyService/#pagerdutyservice","text":"The PagerDuty service that is available for integration with Datadog.","title":"PagerDutyService"},{"location":"v1/PagerDutyService/#properties","text":"Name Type Description Notes service_key str Your service key in PagerDuty. service_name str Your service name associated with a service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/PagerDutyServiceKey/","text":"PagerDutyServiceKey PagerDuty service object key. Properties Name Type Description Notes service_key str Your service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"PagerDutyServiceKey"},{"location":"v1/PagerDutyServiceKey/#pagerdutyservicekey","text":"PagerDuty service object key.","title":"PagerDutyServiceKey"},{"location":"v1/PagerDutyServiceKey/#properties","text":"Name Type Description Notes service_key str Your service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/PagerDutyServiceName/","text":"PagerDutyServiceName PagerDuty service object name. Properties Name Type Description Notes service_name str Your service name associated service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"PagerDutyServiceName"},{"location":"v1/PagerDutyServiceName/#pagerdutyservicename","text":"PagerDuty service object name.","title":"PagerDutyServiceName"},{"location":"v1/PagerDutyServiceName/#properties","text":"Name Type Description Notes service_name str Your service name associated service key in PagerDuty. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Point/","text":"Point Array of timeseries points. Properties Name Type Description Notes value [float] Array of timeseries points. [Back to Model list] [Back to API list] [Back to README]","title":"Point"},{"location":"v1/Point/#point","text":"Array of timeseries points.","title":"Point"},{"location":"v1/Point/#properties","text":"Name Type Description Notes value [float] Array of timeseries points. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ProcessQueryDefinition/","text":"ProcessQueryDefinition The process query to use in the widget. Properties Name Type Description Notes metric str Your chosen metric. filter_by [str] List of processes. [optional] limit int Max number of items in the filter list. [optional] search_by str Your chosen search term. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessQueryDefinition"},{"location":"v1/ProcessQueryDefinition/#processquerydefinition","text":"The process query to use in the widget.","title":"ProcessQueryDefinition"},{"location":"v1/ProcessQueryDefinition/#properties","text":"Name Type Description Notes metric str Your chosen metric. filter_by [str] List of processes. [optional] limit int Max number of items in the filter list. [optional] search_by str Your chosen search term. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QuerySortOrder/","text":"QuerySortOrder Direction of sort. Properties Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"QuerySortOrder"},{"location":"v1/QuerySortOrder/#querysortorder","text":"Direction of sort.","title":"QuerySortOrder"},{"location":"v1/QuerySortOrder/#properties","text":"Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QueryValueWidgetDefinition/","text":"QueryValueWidgetDefinition Query values display the current value of a given metric, APM, or log query. Properties Name Type Description Notes requests [QueryValueWidgetRequest] Widget definition. type QueryValueWidgetDefinitionType autoscale bool Whether to use auto-scaling or not. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] custom_unit str Display a unit of your choice on the widget. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"QueryValueWidgetDefinition"},{"location":"v1/QueryValueWidgetDefinition/#queryvaluewidgetdefinition","text":"Query values display the current value of a given metric, APM, or log query.","title":"QueryValueWidgetDefinition"},{"location":"v1/QueryValueWidgetDefinition/#properties","text":"Name Type Description Notes requests [QueryValueWidgetRequest] Widget definition. type QueryValueWidgetDefinitionType autoscale bool Whether to use auto-scaling or not. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] custom_unit str Display a unit of your choice on the widget. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QueryValueWidgetDefinitionType/","text":"QueryValueWidgetDefinitionType Type of the query value widget. Properties Name Type Description Notes value str Type of the query value widget. defaults to \"query_value\", must be one of [\"query_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"QueryValueWidgetDefinitionType"},{"location":"v1/QueryValueWidgetDefinitionType/#queryvaluewidgetdefinitiontype","text":"Type of the query value widget.","title":"QueryValueWidgetDefinitionType"},{"location":"v1/QueryValueWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the query value widget. defaults to \"query_value\", must be one of [\"query_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/QueryValueWidgetRequest/","text":"QueryValueWidgetRequest Updated query value widget. Properties Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str TODO. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"QueryValueWidgetRequest"},{"location":"v1/QueryValueWidgetRequest/#queryvaluewidgetrequest","text":"Updated query value widget.","title":"QueryValueWidgetRequest"},{"location":"v1/QueryValueWidgetRequest/#properties","text":"Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str TODO. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDelete/","text":"SLOBulkDelete A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID. Properties Name Type Description Notes any string name [SLOTimeframe] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDelete"},{"location":"v1/SLOBulkDelete/#slobulkdelete","text":"A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID.","title":"SLOBulkDelete"},{"location":"v1/SLOBulkDelete/#properties","text":"Name Type Description Notes any string name [SLOTimeframe] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDeleteError/","text":"SLOBulkDeleteError Object describing the error. Properties Name Type Description Notes id str The ID of the service level objective object associated with this error. message str The error message. timeframe SLOErrorTimeframe [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDeleteError"},{"location":"v1/SLOBulkDeleteError/#slobulkdeleteerror","text":"Object describing the error.","title":"SLOBulkDeleteError"},{"location":"v1/SLOBulkDeleteError/#properties","text":"Name Type Description Notes id str The ID of the service level objective object associated with this error. message str The error message. timeframe SLOErrorTimeframe [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDeleteResponse/","text":"SLOBulkDeleteResponse The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the \\\"data\\\" and \\\"error\\\" fields in this response indicate which deletions succeeded and failed. Properties Name Type Description Notes data SLOBulkDeleteResponseData [optional] errors [SLOBulkDeleteError] Array of errors object returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDeleteResponse"},{"location":"v1/SLOBulkDeleteResponse/#slobulkdeleteresponse","text":"The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the \\\"data\\\" and \\\"error\\\" fields in this response indicate which deletions succeeded and failed.","title":"SLOBulkDeleteResponse"},{"location":"v1/SLOBulkDeleteResponse/#properties","text":"Name Type Description Notes data SLOBulkDeleteResponseData [optional] errors [SLOBulkDeleteError] Array of errors object returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOBulkDeleteResponseData/","text":"SLOBulkDeleteResponseData An array of service level objective objects. Properties Name Type Description Notes deleted [str] An array of service level objective object IDs that indicates which objects that were completely deleted. [optional] updated [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOBulkDeleteResponseData"},{"location":"v1/SLOBulkDeleteResponseData/#slobulkdeleteresponsedata","text":"An array of service level objective objects.","title":"SLOBulkDeleteResponseData"},{"location":"v1/SLOBulkDeleteResponseData/#properties","text":"Name Type Description Notes deleted [str] An array of service level objective object IDs that indicates which objects that were completely deleted. [optional] updated [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrection/","text":"SLOCorrection The response object of a list of SLO corrections Properties Name Type Description Notes attributes SLOCorrectionResponseAttributes [optional] id str The ID of the SLO correction [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrection"},{"location":"v1/SLOCorrection/#slocorrection","text":"The response object of a list of SLO corrections","title":"SLOCorrection"},{"location":"v1/SLOCorrection/#properties","text":"Name Type Description Notes attributes SLOCorrectionResponseAttributes [optional] id str The ID of the SLO correction [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCategory/","text":"SLOCorrectionCategory Category the SLO correction belongs to Properties Name Type Description Notes value str Category the SLO correction belongs to must be one of [\"Scheduled Maintenance\", \"Outside Business Hours\", \"Deployment\", \"Other\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCategory"},{"location":"v1/SLOCorrectionCategory/#slocorrectioncategory","text":"Category the SLO correction belongs to","title":"SLOCorrectionCategory"},{"location":"v1/SLOCorrectionCategory/#properties","text":"Name Type Description Notes value str Category the SLO correction belongs to must be one of [\"Scheduled Maintenance\", \"Outside Business Hours\", \"Deployment\", \"Other\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCreateData/","text":"SLOCorrectionCreateData The data object associated with the SLO correction to be created Properties Name Type Description Notes attributes SLOCorrectionCreateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCreateData"},{"location":"v1/SLOCorrectionCreateData/#slocorrectioncreatedata","text":"The data object associated with the SLO correction to be created","title":"SLOCorrectionCreateData"},{"location":"v1/SLOCorrectionCreateData/#properties","text":"Name Type Description Notes attributes SLOCorrectionCreateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCreateRequest/","text":"SLOCorrectionCreateRequest An object that defines a correction to be applied to an SLO Properties Name Type Description Notes data SLOCorrectionCreateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCreateRequest"},{"location":"v1/SLOCorrectionCreateRequest/#slocorrectioncreaterequest","text":"An object that defines a correction to be applied to an SLO","title":"SLOCorrectionCreateRequest"},{"location":"v1/SLOCorrectionCreateRequest/#properties","text":"Name Type Description Notes data SLOCorrectionCreateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionCreateRequestAttributes/","text":"SLOCorrectionCreateRequestAttributes The attribute object associated with the SLO correction to be created Properties Name Type Description Notes category SLOCorrectionCategory end int Ending time of the correction in epoch seconds slo_id str ID of the SLO that this correction will be applied to start int Starting time of the correction in epoch seconds description str Description of the correction being made. [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionCreateRequestAttributes"},{"location":"v1/SLOCorrectionCreateRequestAttributes/#slocorrectioncreaterequestattributes","text":"The attribute object associated with the SLO correction to be created","title":"SLOCorrectionCreateRequestAttributes"},{"location":"v1/SLOCorrectionCreateRequestAttributes/#properties","text":"Name Type Description Notes category SLOCorrectionCategory end int Ending time of the correction in epoch seconds slo_id str ID of the SLO that this correction will be applied to start int Starting time of the correction in epoch seconds description str Description of the correction being made. [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionListResponse/","text":"SLOCorrectionListResponse A list of SLO correction objects Properties Name Type Description Notes data [SLOCorrection] The list of of SLO corrections objects [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionListResponse"},{"location":"v1/SLOCorrectionListResponse/#slocorrectionlistresponse","text":"A list of SLO correction objects","title":"SLOCorrectionListResponse"},{"location":"v1/SLOCorrectionListResponse/#properties","text":"Name Type Description Notes data [SLOCorrection] The list of of SLO corrections objects [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionResponse/","text":"SLOCorrectionResponse The response object of an SLO correction Properties Name Type Description Notes data SLOCorrection [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionResponse"},{"location":"v1/SLOCorrectionResponse/#slocorrectionresponse","text":"The response object of an SLO correction","title":"SLOCorrectionResponse"},{"location":"v1/SLOCorrectionResponse/#properties","text":"Name Type Description Notes data SLOCorrection [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionResponseAttributes/","text":"SLOCorrectionResponseAttributes The attribute object associated with the SLO correction Properties Name Type Description Notes category SLOCorrectionCategory [optional] creator Creator [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] slo_id str ID of the SLO that this correction will be applied to [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionResponseAttributes"},{"location":"v1/SLOCorrectionResponseAttributes/#slocorrectionresponseattributes","text":"The attribute object associated with the SLO correction","title":"SLOCorrectionResponseAttributes"},{"location":"v1/SLOCorrectionResponseAttributes/#properties","text":"Name Type Description Notes category SLOCorrectionCategory [optional] creator Creator [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] slo_id str ID of the SLO that this correction will be applied to [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionType/","text":"SLOCorrectionType SLO correction resource type. Properties Name Type Description Notes value str SLO correction resource type. defaults to \"correction\", must be one of [\"correction\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionType"},{"location":"v1/SLOCorrectionType/#slocorrectiontype","text":"SLO correction resource type.","title":"SLOCorrectionType"},{"location":"v1/SLOCorrectionType/#properties","text":"Name Type Description Notes value str SLO correction resource type. defaults to \"correction\", must be one of [\"correction\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionUpdateData/","text":"SLOCorrectionUpdateData The data object associated with the SLO correction to be updated Properties Name Type Description Notes attributes SLOCorrectionUpdateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionUpdateData"},{"location":"v1/SLOCorrectionUpdateData/#slocorrectionupdatedata","text":"The data object associated with the SLO correction to be updated","title":"SLOCorrectionUpdateData"},{"location":"v1/SLOCorrectionUpdateData/#properties","text":"Name Type Description Notes attributes SLOCorrectionUpdateRequestAttributes [optional] type SLOCorrectionType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionUpdateRequest/","text":"SLOCorrectionUpdateRequest An object that defines a correction to be applied to an SLO Properties Name Type Description Notes data SLOCorrectionUpdateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionUpdateRequest"},{"location":"v1/SLOCorrectionUpdateRequest/#slocorrectionupdaterequest","text":"An object that defines a correction to be applied to an SLO","title":"SLOCorrectionUpdateRequest"},{"location":"v1/SLOCorrectionUpdateRequest/#properties","text":"Name Type Description Notes data SLOCorrectionUpdateData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOCorrectionUpdateRequestAttributes/","text":"SLOCorrectionUpdateRequestAttributes The attribute object associated with the SLO correction to be updated Properties Name Type Description Notes category SLOCorrectionCategory [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOCorrectionUpdateRequestAttributes"},{"location":"v1/SLOCorrectionUpdateRequestAttributes/#slocorrectionupdaterequestattributes","text":"The attribute object associated with the SLO correction to be updated","title":"SLOCorrectionUpdateRequestAttributes"},{"location":"v1/SLOCorrectionUpdateRequestAttributes/#properties","text":"Name Type Description Notes category SLOCorrectionCategory [optional] description str Description of the correction being made. [optional] end int Ending time of the correction in epoch seconds [optional] start int Starting time of the correction in epoch seconds [optional] timezone str The timezone to display in the UI for the correction times (defaults to \\\"UTC\\\") [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLODeleteResponse/","text":"SLODeleteResponse A response list of all service level objective deleted. Properties Name Type Description Notes data [str] An array containing the ID of the deleted service level objective object. [optional] errors {str: (str,)} An dictionary containing the ID of the SLO as key and a deletion error as value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLODeleteResponse"},{"location":"v1/SLODeleteResponse/#slodeleteresponse","text":"A response list of all service level objective deleted.","title":"SLODeleteResponse"},{"location":"v1/SLODeleteResponse/#properties","text":"Name Type Description Notes data [str] An array containing the ID of the deleted service level objective object. [optional] errors {str: (str,)} An dictionary containing the ID of the SLO as key and a deletion error as value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOErrorBudgetRemainingData/","text":"SLOErrorBudgetRemainingData A mapping of threshold timeframe to the remaining error budget. Properties Name Type Description Notes any string name float any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOErrorBudgetRemainingData"},{"location":"v1/SLOErrorBudgetRemainingData/#sloerrorbudgetremainingdata","text":"A mapping of threshold timeframe to the remaining error budget.","title":"SLOErrorBudgetRemainingData"},{"location":"v1/SLOErrorBudgetRemainingData/#properties","text":"Name Type Description Notes any string name float any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOErrorTimeframe/","text":"SLOErrorTimeframe The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected. Properties Name Type Description Notes value str The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected. must be one of [\"7d\", \"30d\", \"90d\", \"all\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOErrorTimeframe"},{"location":"v1/SLOErrorTimeframe/#sloerrortimeframe","text":"The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected.","title":"SLOErrorTimeframe"},{"location":"v1/SLOErrorTimeframe/#properties","text":"Name Type Description Notes value str The timeframe of the threshold associated with this error or \\\"all\\\" if all thresholds are affected. must be one of [\"7d\", \"30d\", \"90d\", \"all\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetrics/","text":"SLOHistoryMetrics A metric based SLO history response. This is not included in responses for monitor based SLOs. Properties Name Type Description Notes denominator SLOHistoryMetricsSeries interval int The aggregated query interval for the series data. It's implicit based on the query time window. numerator SLOHistoryMetricsSeries query str The combined numerator and denominator query CSV. res_type str The series result type. This mimics `batch_query` response type. resp_version int The series response version type. This mimics `batch_query` response type. times [float] An array of query timestamps in EPOCH milliseconds message str Optional message if there are specific query issues/warnings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetrics"},{"location":"v1/SLOHistoryMetrics/#slohistorymetrics","text":"A metric based SLO history response. This is not included in responses for monitor based SLOs.","title":"SLOHistoryMetrics"},{"location":"v1/SLOHistoryMetrics/#properties","text":"Name Type Description Notes denominator SLOHistoryMetricsSeries interval int The aggregated query interval for the series data. It's implicit based on the query time window. numerator SLOHistoryMetricsSeries query str The combined numerator and denominator query CSV. res_type str The series result type. This mimics `batch_query` response type. resp_version int The series response version type. This mimics `batch_query` response type. times [float] An array of query timestamps in EPOCH milliseconds message str Optional message if there are specific query issues/warnings. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetricsSeries/","text":"SLOHistoryMetricsSeries A representation of metric based SLO time series for the provided queries. This is the same response type from batch_query endpoint. Properties Name Type Description Notes count int Count of submitted metrics. metadata SLOHistoryMetricsSeriesMetadata sum float Total sum of the query. values [float] The query values for each metric. [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetricsSeries"},{"location":"v1/SLOHistoryMetricsSeries/#slohistorymetricsseries","text":"A representation of metric based SLO time series for the provided queries. This is the same response type from batch_query endpoint.","title":"SLOHistoryMetricsSeries"},{"location":"v1/SLOHistoryMetricsSeries/#properties","text":"Name Type Description Notes count int Count of submitted metrics. metadata SLOHistoryMetricsSeriesMetadata sum float Total sum of the query. values [float] The query values for each metric. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetricsSeriesMetadata/","text":"SLOHistoryMetricsSeriesMetadata Query metadata. Properties Name Type Description Notes aggr str Query aggregator function. [optional] expression str Query expression. [optional] metric str Query metric used. [optional] query_index int Query index from original combined query. [optional] scope str Query scope. [optional] unit [SLOHistoryMetricsSeriesMetadataUnit], none_type 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetricsSeriesMetadata"},{"location":"v1/SLOHistoryMetricsSeriesMetadata/#slohistorymetricsseriesmetadata","text":"Query metadata.","title":"SLOHistoryMetricsSeriesMetadata"},{"location":"v1/SLOHistoryMetricsSeriesMetadata/#properties","text":"Name Type Description Notes aggr str Query aggregator function. [optional] expression str Query expression. [optional] metric str Query metric used. [optional] query_index int Query index from original combined query. [optional] scope str Query scope. [optional] unit [SLOHistoryMetricsSeriesMetadataUnit], none_type 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryMetricsSeriesMetadataUnit/","text":"SLOHistoryMetricsSeriesMetadataUnit An Object of metric units. Properties Name Type Description Notes family str The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. [optional] id int The ID of the metric unit. [optional] name str The unit of the metric, for instance `byte`. [optional] plural str, none_type 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 str, none_type A shorter and abbreviated version of the metric unit, for instance `B`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryMetricsSeriesMetadataUnit"},{"location":"v1/SLOHistoryMetricsSeriesMetadataUnit/#slohistorymetricsseriesmetadataunit","text":"An Object of metric units.","title":"SLOHistoryMetricsSeriesMetadataUnit"},{"location":"v1/SLOHistoryMetricsSeriesMetadataUnit/#properties","text":"Name Type Description Notes family str The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. [optional] id int The ID of the metric unit. [optional] name str The unit of the metric, for instance `byte`. [optional] plural str, none_type 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 str, none_type A shorter and abbreviated version of the metric unit, for instance `B`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryResponse/","text":"SLOHistoryResponse A service level objective history response. Properties Name Type Description Notes data SLOHistoryResponseData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryResponse"},{"location":"v1/SLOHistoryResponse/#slohistoryresponse","text":"A service level objective history response.","title":"SLOHistoryResponse"},{"location":"v1/SLOHistoryResponse/#properties","text":"Name Type Description Notes data SLOHistoryResponseData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryResponseData/","text":"SLOHistoryResponseData An array of service level objective objects. Properties Name Type Description Notes from_ts int The `from` timestamp in epoch seconds. [optional] group_by [str] 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 [SLOHistorySLIData] For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. [optional] monitors [SLOHistorySLIData] 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 [optional] series SLOHistoryMetrics [optional] thresholds {str: (SLOThreshold,)} mapping of string timeframe to the SLO threshold. [optional] to_ts int The `to` timestamp in epoch seconds. [optional] type SLOType [optional] type_id SLOTypeNumeric [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryResponseData"},{"location":"v1/SLOHistoryResponseData/#slohistoryresponsedata","text":"An array of service level objective objects.","title":"SLOHistoryResponseData"},{"location":"v1/SLOHistoryResponseData/#properties","text":"Name Type Description Notes from_ts int The `from` timestamp in epoch seconds. [optional] group_by [str] 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 [SLOHistorySLIData] For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. [optional] monitors [SLOHistorySLIData] 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 [optional] series SLOHistoryMetrics [optional] thresholds {str: (SLOThreshold,)} mapping of string timeframe to the SLO threshold. [optional] to_ts int The `to` timestamp in epoch seconds. [optional] type SLOType [optional] type_id SLOTypeNumeric [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistoryResponseError/","text":"SLOHistoryResponseError A service level objective response containing the requested history. Properties Name Type Description Notes error str Human readable error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistoryResponseError"},{"location":"v1/SLOHistoryResponseError/#slohistoryresponseerror","text":"A service level objective response containing the requested history.","title":"SLOHistoryResponseError"},{"location":"v1/SLOHistoryResponseError/#properties","text":"Name Type Description Notes error str Human readable error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOHistorySLIData/","text":"SLOHistorySLIData An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs. Properties Name Type Description Notes error_budget_remaining SLOErrorBudgetRemainingData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] group str For groups in a grouped SLO, this is the group name. [optional] history [[float]] For `monitor` based SLOs, this includes the aggregated history uptime time series. [optional] monitor_modified int For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. [optional] monitor_type str For `monitor` based SLOs, this describes the type of monitor. [optional] name str 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 {str: (float,)} A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. [optional] preview bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOHistorySLIData"},{"location":"v1/SLOHistorySLIData/#slohistoryslidata","text":"An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.","title":"SLOHistorySLIData"},{"location":"v1/SLOHistorySLIData/#properties","text":"Name Type Description Notes error_budget_remaining SLOErrorBudgetRemainingData [optional] errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional] group str For groups in a grouped SLO, this is the group name. [optional] history [[float]] For `monitor` based SLOs, this includes the aggregated history uptime time series. [optional] monitor_modified int For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. [optional] monitor_type str For `monitor` based SLOs, this describes the type of monitor. [optional] name str 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 {str: (float,)} A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. [optional] preview bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOListResponse/","text":"SLOListResponse A response with one or more service level objective. Properties Name Type Description Notes data [ServiceLevelObjective] An array of service level objective objects. [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] metadata SLOListResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOListResponse"},{"location":"v1/SLOListResponse/#slolistresponse","text":"A response with one or more service level objective.","title":"SLOListResponse"},{"location":"v1/SLOListResponse/#properties","text":"Name Type Description Notes data [ServiceLevelObjective] An array of service level objective objects. [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] metadata SLOListResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOListResponseMetadata/","text":"SLOListResponseMetadata The metadata object containing additional information about the list of SLOs. Properties Name Type Description Notes page SLOListResponseMetadataPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOListResponseMetadata"},{"location":"v1/SLOListResponseMetadata/#slolistresponsemetadata","text":"The metadata object containing additional information about the list of SLOs.","title":"SLOListResponseMetadata"},{"location":"v1/SLOListResponseMetadata/#properties","text":"Name Type Description Notes page SLOListResponseMetadataPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOListResponseMetadataPage/","text":"SLOListResponseMetadataPage The object containing information about the pages of the list of SLOs. Properties Name Type Description Notes total_count int The total number of resources that could be retrieved ignoring the parameters and filters in the request. [optional] total_filtered_count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOListResponseMetadataPage"},{"location":"v1/SLOListResponseMetadataPage/#slolistresponsemetadatapage","text":"The object containing information about the pages of the list of SLOs.","title":"SLOListResponseMetadataPage"},{"location":"v1/SLOListResponseMetadataPage/#properties","text":"Name Type Description Notes total_count int The total number of resources that could be retrieved ignoring the parameters and filters in the request. [optional] total_filtered_count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOResponse/","text":"SLOResponse A service level objective response containing a single service level objective. Properties Name Type Description Notes data SLOResponseData [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOResponse"},{"location":"v1/SLOResponse/#sloresponse","text":"A service level objective response containing a single service level objective.","title":"SLOResponse"},{"location":"v1/SLOResponse/#properties","text":"Name Type Description Notes data SLOResponseData [optional] errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOResponseData/","text":"SLOResponseData A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.). Properties Name Type Description Notes configured_alert_ids [int] 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 int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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 str The name of the service level objective object. [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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 [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. [optional] type SLOType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOResponseData"},{"location":"v1/SLOResponseData/#sloresponsedata","text":"A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.).","title":"SLOResponseData"},{"location":"v1/SLOResponseData/#properties","text":"Name Type Description Notes configured_alert_ids [int] 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 int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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 str The name of the service level objective object. [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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 [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. [optional] type SLOType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOThreshold/","text":"SLOThreshold SLO thresholds (target and optionally warning) for a single time window. Properties Name Type Description Notes target float The target value for the service level indicator within the corresponding timeframe. timeframe SLOTimeframe target_display str 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] warning float The warning value for the service level objective. [optional] warning_display str 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] [Back to Model list] [Back to API list] [Back to README]","title":"SLOThreshold"},{"location":"v1/SLOThreshold/#slothreshold","text":"SLO thresholds (target and optionally warning) for a single time window.","title":"SLOThreshold"},{"location":"v1/SLOThreshold/#properties","text":"Name Type Description Notes target float The target value for the service level indicator within the corresponding timeframe. timeframe SLOTimeframe target_display str 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] warning float The warning value for the service level objective. [optional] warning_display str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOTimeframe/","text":"SLOTimeframe The SLO time window options. Properties Name Type Description Notes value str The SLO time window options. must be one of [\"7d\", \"30d\", \"90d\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOTimeframe"},{"location":"v1/SLOTimeframe/#slotimeframe","text":"The SLO time window options.","title":"SLOTimeframe"},{"location":"v1/SLOTimeframe/#properties","text":"Name Type Description Notes value str The SLO time window options. must be one of [\"7d\", \"30d\", \"90d\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOType/","text":"SLOType The type of the service level objective. Properties Name Type Description Notes value str The type of the service level objective. must be one of [\"metric\", \"monitor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOType"},{"location":"v1/SLOType/#slotype","text":"The type of the service level objective.","title":"SLOType"},{"location":"v1/SLOType/#properties","text":"Name Type Description Notes value str The type of the service level objective. must be one of [\"metric\", \"monitor\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOTypeNumeric/","text":"SLOTypeNumeric A numeric representation of the type of the service level objective ( 0 for monitor, 1 for metric). Always included in service level objective responses. Ignored in create/update requests. Properties Name Type Description Notes value int A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. must be one of [0, 1, ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOTypeNumeric"},{"location":"v1/SLOTypeNumeric/#slotypenumeric","text":"A numeric representation of the type of the service level objective ( 0 for monitor, 1 for metric). Always included in service level objective responses. Ignored in create/update requests.","title":"SLOTypeNumeric"},{"location":"v1/SLOTypeNumeric/#properties","text":"Name Type Description Notes value int A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. must be one of [0, 1, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOWidgetDefinition/","text":"SLOWidgetDefinition Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards. Properties Name Type Description Notes type SLOWidgetDefinitionType view_type str Type of view displayed by the widget. defaults to \"detail\" global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] view_mode WidgetViewMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SLOWidgetDefinition"},{"location":"v1/SLOWidgetDefinition/#slowidgetdefinition","text":"Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.","title":"SLOWidgetDefinition"},{"location":"v1/SLOWidgetDefinition/#properties","text":"Name Type Description Notes type SLOWidgetDefinitionType view_type str Type of view displayed by the widget. defaults to \"detail\" global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] view_mode WidgetViewMode [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SLOWidgetDefinitionType/","text":"SLOWidgetDefinitionType Type of the SLO widget. Properties Name Type Description Notes value str Type of the SLO widget. defaults to \"slo\", must be one of [\"slo\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SLOWidgetDefinitionType"},{"location":"v1/SLOWidgetDefinitionType/#slowidgetdefinitiontype","text":"Type of the SLO widget.","title":"SLOWidgetDefinitionType"},{"location":"v1/SLOWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the SLO widget. defaults to \"slo\", must be one of [\"slo\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotRequest/","text":"ScatterPlotRequest Updated scatter plot. Properties Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotRequest"},{"location":"v1/ScatterPlotRequest/#scatterplotrequest","text":"Updated scatter plot.","title":"ScatterPlotRequest"},{"location":"v1/ScatterPlotRequest/#properties","text":"Name Type Description Notes aggregator WidgetAggregator [optional] apm_query LogQueryDefinition [optional] event_query LogQueryDefinition [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotWidgetDefinition/","text":"ScatterPlotWidgetDefinition The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. Properties Name Type Description Notes requests ScatterPlotWidgetDefinitionRequests type ScatterPlotWidgetDefinitionType color_by_groups [str] List of groups used for colors. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotWidgetDefinition"},{"location":"v1/ScatterPlotWidgetDefinition/#scatterplotwidgetdefinition","text":"The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.","title":"ScatterPlotWidgetDefinition"},{"location":"v1/ScatterPlotWidgetDefinition/#properties","text":"Name Type Description Notes requests ScatterPlotWidgetDefinitionRequests type ScatterPlotWidgetDefinitionType color_by_groups [str] List of groups used for colors. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotWidgetDefinitionRequests/","text":"ScatterPlotWidgetDefinitionRequests Widget definition. Properties Name Type Description Notes x ScatterPlotRequest y ScatterPlotRequest [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotWidgetDefinitionRequests"},{"location":"v1/ScatterPlotWidgetDefinitionRequests/#scatterplotwidgetdefinitionrequests","text":"Widget definition.","title":"ScatterPlotWidgetDefinitionRequests"},{"location":"v1/ScatterPlotWidgetDefinitionRequests/#properties","text":"Name Type Description Notes x ScatterPlotRequest y ScatterPlotRequest [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ScatterPlotWidgetDefinitionType/","text":"ScatterPlotWidgetDefinitionType Type of the scatter plot widget. Properties Name Type Description Notes value str Type of the scatter plot widget. defaults to \"scatterplot\", must be one of [\"scatterplot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ScatterPlotWidgetDefinitionType"},{"location":"v1/ScatterPlotWidgetDefinitionType/#scatterplotwidgetdefinitiontype","text":"Type of the scatter plot widget.","title":"ScatterPlotWidgetDefinitionType"},{"location":"v1/ScatterPlotWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the scatter plot widget. defaults to \"scatterplot\", must be one of [\"scatterplot\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/Series/","text":"Series A metric to submit to Datadog. See Datadog metrics . Properties Name Type Description Notes metric str The name of the timeseries. points [Point] 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. host str The name of the host that produced the metric. [optional] interval int, none_type If the type of the metric is rate or count, define the corresponding interval. [optional] tags [str] A list of tags associated with the metric. [optional] type str The type of the metric either `count`, `gauge`, or `rate`. [optional] if omitted the server will use the default value of \"gauge\" [Back to Model list] [Back to API list] [Back to README]","title":"Series"},{"location":"v1/Series/#series","text":"A metric to submit to Datadog. See Datadog metrics .","title":"Series"},{"location":"v1/Series/#properties","text":"Name Type Description Notes metric str The name of the timeseries. points [Point] 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. host str The name of the host that produced the metric. [optional] interval int, none_type If the type of the metric is rate or count, define the corresponding interval. [optional] tags [str] A list of tags associated with the metric. [optional] type str The type of the metric either `count`, `gauge`, or `rate`. [optional] if omitted the server will use the default value of \"gauge\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceCheck/","text":"ServiceCheck An object containing service check and status. Properties Name Type Description Notes check str The check. host_name str The host name correlated with the check. status ServiceCheckStatus tags [str] Tags related to a check. message str Message containing check status. [optional] timestamp int Time of check. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceCheck"},{"location":"v1/ServiceCheck/#servicecheck","text":"An object containing service check and status.","title":"ServiceCheck"},{"location":"v1/ServiceCheck/#properties","text":"Name Type Description Notes check str The check. host_name str The host name correlated with the check. status ServiceCheckStatus tags [str] Tags related to a check. message str Message containing check status. [optional] timestamp int Time of check. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceCheckStatus/","text":"ServiceCheckStatus The status of a service check. Properties Name Type Description Notes value int The status of a service check. must be one of [0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceCheckStatus"},{"location":"v1/ServiceCheckStatus/#servicecheckstatus","text":"The status of a service check.","title":"ServiceCheckStatus"},{"location":"v1/ServiceCheckStatus/#properties","text":"Name Type Description Notes value int The status of a service check. must be one of [0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceChecks/","text":"ServiceChecks The service checks. Properties Name Type Description Notes value [ServiceCheck] The service checks. [Back to Model list] [Back to API list] [Back to README]","title":"ServiceChecks"},{"location":"v1/ServiceChecks/#servicechecks","text":"The service checks.","title":"ServiceChecks"},{"location":"v1/ServiceChecks/#properties","text":"Name Type Description Notes value [ServiceCheck] The service checks. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceChecksApi/","text":"datadog_api_client.v1.ServiceChecksApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description submit_service_check POST /api/v1/check_run Submit a Service Check submit_service_check IntakePayloadAccepted submit_service_check(body) Submit a Service Check Submit a list of Service Checks. Note : A valid API key is required. Example Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_checks_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_checks_api.ServiceChecksApi(api_client) body = ServiceChecks([ ServiceCheck( check=\"app.ok\", host_name=\"app.host1\", message=\"app is running\", status=ServiceCheckStatus(0), tags=[\"environment:test\"], timestamp=1, ), ]) # ServiceChecks | Service Check request body. # example passing only required values which don't have defaults set try: # Submit a Service Check api_response = api_instance.submit_service_check(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceChecksApi->submit_service_check: %s\\n\" % e) Parameters Name Type Description Notes body ServiceChecks Service Check request body. Return type IntakePayloadAccepted Authorization apiKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication Error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.ServiceChecksApi"},{"location":"v1/ServiceChecksApi/#datadog_api_clientv1servicechecksapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description submit_service_check POST /api/v1/check_run Submit a Service Check","title":"datadog_api_client.v1.ServiceChecksApi"},{"location":"v1/ServiceChecksApi/#submit_service_check","text":"IntakePayloadAccepted submit_service_check(body) Submit a Service Check Submit a list of Service Checks. Note : A valid API key is required.","title":"submit_service_check"},{"location":"v1/ServiceChecksApi/#example","text":"Api Key Authentication (apiKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_checks_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_checks_api.ServiceChecksApi(api_client) body = ServiceChecks([ ServiceCheck( check=\"app.ok\", host_name=\"app.host1\", message=\"app is running\", status=ServiceCheckStatus(0), tags=[\"environment:test\"], timestamp=1, ), ]) # ServiceChecks | Service Check request body. # example passing only required values which don't have defaults set try: # Submit a Service Check api_response = api_instance.submit_service_check(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceChecksApi->submit_service_check: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceChecksApi/#parameters","text":"Name Type Description Notes body ServiceChecks Service Check request body.","title":"Parameters"},{"location":"v1/ServiceChecksApi/#return-type","text":"IntakePayloadAccepted","title":"Return type"},{"location":"v1/ServiceChecksApi/#authorization","text":"apiKeyAuth","title":"Authorization"},{"location":"v1/ServiceChecksApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceChecksApi/#http-response-details","text":"Status code Description Response headers 202 Payload accepted - 400 Bad Request - 403 Authentication Error - 408 Request timeout - 413 Payload too large - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjective/","text":"ServiceLevelObjective A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.). Properties Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceLevelObjective"},{"location":"v1/ServiceLevelObjective/#servicelevelobjective","text":"A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.).","title":"ServiceLevelObjective"},{"location":"v1/ServiceLevelObjective/#properties","text":"Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. optional creator Creator [optional] description str, none_type 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 [str] 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 str A unique identifier for the service level objective object. Always included in service level objective responses. optional modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. optional monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] monitor_tags [str] 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] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/","text":"datadog_api_client.v1.ServiceLevelObjectiveCorrectionsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slo_correction POST /api/v1/slo/correction Create an SLO correction delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO list_slo_correction GET /api/v1/slo/correction Get all SLO corrections update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction create_slo_correction SLOCorrectionResponse create_slo_correction(body) Create an SLO correction Create an SLO Correction Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) body = SLOCorrectionCreateRequest( data=SLOCorrectionCreateData( attributes=SLOCorrectionCreateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, slo_id=\"sloId\", start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionCreateRequest | Create an SLO Correction # example passing only required values which don't have defaults set try: # Create an SLO correction api_response = api_instance.create_slo_correction(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->create_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes body SLOCorrectionCreateRequest Create an SLO Correction Return type SLOCorrectionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_slo_correction delete_slo_correction(slo_correction_id) Delete an SLO correction Permanently delete the specified SLO correction object Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Delete an SLO correction api_instance.delete_slo_correction(slo_correction_id) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->delete_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes slo_correction_id str The ID of the SLO correction object Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slo_correction SLOCorrectionResponse get_slo_correction(slo_correction_id) Get an SLO correction for an SLO Get an SLO correction Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Get an SLO correction for an SLO api_response = api_instance.get_slo_correction(slo_correction_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->get_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes slo_correction_id str The ID of the SLO correction object Return type SLOCorrectionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_slo_correction SLOCorrectionListResponse list_slo_correction() Get all SLO corrections Get all Service Level Objective corrections Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all SLO corrections api_response = api_instance.list_slo_correction() pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->list_slo_correction: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type SLOCorrectionListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_slo_correction SLOCorrectionResponse update_slo_correction(slo_correction_id, body) Update an SLO correction Update the specified SLO correction object object Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object body = SLOCorrectionUpdateRequest( data=SLOCorrectionUpdateData( attributes=SLOCorrectionUpdateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionUpdateRequest | The edited SLO correction object. # example passing only required values which don't have defaults set try: # Update an SLO correction api_response = api_instance.update_slo_correction(slo_correction_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->update_slo_correction: %s\\n\" % e) Parameters Name Type Description Notes slo_correction_id str The ID of the SLO correction object body SLOCorrectionUpdateRequest The edited SLO correction object. Return type SLOCorrectionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.ServiceLevelObjectiveCorrectionsApi"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#datadog_api_clientv1servicelevelobjectivecorrectionsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slo_correction POST /api/v1/slo/correction Create an SLO correction delete_slo_correction DELETE /api/v1/slo/correction/{slo_correction_id} Delete an SLO correction get_slo_correction GET /api/v1/slo/correction/{slo_correction_id} Get an SLO correction for an SLO list_slo_correction GET /api/v1/slo/correction Get all SLO corrections update_slo_correction PATCH /api/v1/slo/correction/{slo_correction_id} Update an SLO correction","title":"datadog_api_client.v1.ServiceLevelObjectiveCorrectionsApi"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#create_slo_correction","text":"SLOCorrectionResponse create_slo_correction(body) Create an SLO correction Create an SLO Correction","title":"create_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) body = SLOCorrectionCreateRequest( data=SLOCorrectionCreateData( attributes=SLOCorrectionCreateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, slo_id=\"sloId\", start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionCreateRequest | Create an SLO Correction # example passing only required values which don't have defaults set try: # Create an SLO correction api_response = api_instance.create_slo_correction(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->create_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters","text":"Name Type Description Notes body SLOCorrectionCreateRequest Create an SLO Correction","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type","text":"SLOCorrectionResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#delete_slo_correction","text":"delete_slo_correction(slo_correction_id) Delete an SLO correction Permanently delete the specified SLO correction object","title":"delete_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Delete an SLO correction api_instance.delete_slo_correction(slo_correction_id) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->delete_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_1","text":"Name Type Description Notes slo_correction_id str The ID of the SLO correction object","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#get_slo_correction","text":"SLOCorrectionResponse get_slo_correction(slo_correction_id) Get an SLO correction for an SLO Get an SLO correction","title":"get_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object # example passing only required values which don't have defaults set try: # Get an SLO correction for an SLO api_response = api_instance.get_slo_correction(slo_correction_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->get_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_2","text":"Name Type Description Notes slo_correction_id str The ID of the SLO correction object","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_2","text":"SLOCorrectionResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#list_slo_correction","text":"SLOCorrectionListResponse list_slo_correction() Get all SLO corrections Get all Service Level Objective corrections","title":"list_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all SLO corrections api_response = api_instance.list_slo_correction() pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->list_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_3","text":"SLOCorrectionListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#update_slo_correction","text":"SLOCorrectionResponse update_slo_correction(slo_correction_id, body) Update an SLO correction Update the specified SLO correction object object","title":"update_slo_correction"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objective_corrections_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_slo_correction\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objective_corrections_api.ServiceLevelObjectiveCorrectionsApi(api_client) slo_correction_id = \"slo_correction_id_example\" # str | The ID of the SLO correction object body = SLOCorrectionUpdateRequest( data=SLOCorrectionUpdateData( attributes=SLOCorrectionUpdateRequestAttributes( category=SLOCorrectionCategory(\"Scheduled Maintenance\"), description=\"description_example\", end=1600000000, start=1600000000, timezone=\"UTC\", ), type=SLOCorrectionType(\"correction\"), ), ) # SLOCorrectionUpdateRequest | The edited SLO correction object. # example passing only required values which don't have defaults set try: # Update an SLO correction api_response = api_instance.update_slo_correction(slo_correction_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectiveCorrectionsApi->update_slo_correction: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#parameters_4","text":"Name Type Description Notes slo_correction_id str The ID of the SLO correction object body SLOCorrectionUpdateRequest The edited SLO correction object.","title":"Parameters"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#return-type_4","text":"SLOCorrectionResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectiveCorrectionsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectiveQuery/","text":"ServiceLevelObjectiveQuery A metric SLI query. Required if type is metric . Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests. Properties Name Type Description Notes denominator str A Datadog metric query for total (valid) events. numerator str A Datadog metric query for good events. [Back to Model list] [Back to API list] [Back to README]","title":"ServiceLevelObjectiveQuery"},{"location":"v1/ServiceLevelObjectiveQuery/#servicelevelobjectivequery","text":"A metric SLI query. Required if type is metric . Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.","title":"ServiceLevelObjectiveQuery"},{"location":"v1/ServiceLevelObjectiveQuery/#properties","text":"Name Type Description Notes denominator str A Datadog metric query for total (valid) events. numerator str A Datadog metric query for good events. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceLevelObjectiveRequest/","text":"ServiceLevelObjectiveRequest A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.). Properties Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType description str, none_type 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 [str] 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 [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceLevelObjectiveRequest"},{"location":"v1/ServiceLevelObjectiveRequest/#servicelevelobjectiverequest","text":"A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata ( name , description , tags , etc.).","title":"ServiceLevelObjectiveRequest"},{"location":"v1/ServiceLevelObjectiveRequest/#properties","text":"Name Type Description Notes name str The name of the service level objective object. thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object. type SLOType description str, none_type 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 [str] 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 [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor` . [optional] query ServiceLevelObjectiveQuery [optional] tags [str] 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceLevelObjectivesApi/","text":"datadog_api_client.v1.ServiceLevelObjectivesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted create_slo POST /api/v1/slo Create an SLO object delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes get_slo GET /api/v1/slo/{slo_id} Get an SLO's details get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history list_slos GET /api/v1/slo Get all SLOs update_slo PUT /api/v1/slo/{slo_id} Update an SLO check_can_delete_slo CheckCanDeleteSLOResponse check_can_delete_slo(ids) Check if SLOs can be safely deleted Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. # example passing only required values which don't have defaults set try: # Check if SLOs can be safely deleted api_response = api_instance.check_can_delete_slo(ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->check_can_delete_slo: %s\\n\" % e) Parameters Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects. Return type CheckCanDeleteSLOResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_slo SLOListResponse create_slo(body) Create an SLO object Create a service level objective object. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = ServiceLevelObjectiveRequest( description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], monitor_ids=[ 1, ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjectiveRequest | Service level objective request object. # example passing only required values which don't have defaults set try: # Create an SLO object api_response = api_instance.create_slo(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->create_slo: %s\\n\" % e) Parameters Name Type Description Notes body ServiceLevelObjectiveRequest Service level objective request object. Return type SLOListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_slo SLODeleteResponse delete_slo(slo_id) Delete an SLO Permanently delete the specified service level objective object. If an SLO is used in a dashboard, the DELETE /v1/slo/ endpoint returns a 409 conflict error because the SLO is referenced in a dashboard. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete an SLO api_response = api_instance.delete_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete an SLO api_response = api_instance.delete_slo(slo_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional] Return type SLODeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_slo_timeframe_in_bulk SLOBulkDeleteResponse delete_slo_timeframe_in_bulk(body) Bulk Delete SLO Timeframes Delete (or partially delete) multiple service level objective objects. This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = SLOBulkDelete( key=[ SLOTimeframe(\"7d\"), ], ) # SLOBulkDelete | Delete multiple service level objective objects request body. # example passing only required values which don't have defaults set try: # Bulk Delete SLO Timeframes api_response = api_instance.delete_slo_timeframe_in_bulk(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo_timeframe_in_bulk: %s\\n\" % e) Parameters Name Type Description Notes body SLOBulkDelete Delete multiple service level objective objects request body. Return type SLOBulkDeleteResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slo SLOResponse get_slo(slo_id) Get an SLO's details Get a service level objective object. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. with_configured_alert_ids = True # bool | Get the IDs of SLO monitors that reference this SLO. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's details api_response = api_instance.get_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's details api_response = api_instance.get_slo(slo_id, with_configured_alert_ids=with_configured_alert_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective object. with_configured_alert_ids bool Get the IDs of SLO monitors that reference this SLO. [optional] Return type SLOResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slo_history SLOHistoryResponse get_slo_history(slo_id, from_ts, to_ts) Get an SLO's history Get a specific SLO\u2019s history, regardless of its SLO type. The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history. Note: There are different response formats for event based and time based SLOs. Examples of both are shown. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_history\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. from_ts = 1 # int | The `from` timestamp for the query window in epoch seconds. to_ts = 1 # int | The `to` timestamp for the query window in epoch seconds. target = 0 # float | The SLO target. If `target` is passed in, the response will include the error budget that remains. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts, target=target) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective object. from_ts int The `from` timestamp for the query window in epoch seconds. to_ts int 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 error budget that remains. [optional] Return type SLOHistoryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_slos SLOListResponse list_slos() Get all SLOs Get a list of service level objective objects for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. (optional) query = \"monitor\" # str | The query string to filter results based on SLO names. (optional) tags_query = \"env:prod\" # str | The query string to filter results based on a single SLO tag. (optional) metrics_query = \"aws.elb.request_count\" # str | The query string to filter results based on SLO numerator and denominator. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all SLOs api_response = api_instance.list_slos(ids=ids, query=query, tags_query=tags_query, metrics_query=metrics_query) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->list_slos: %s\\n\" % e) Parameters Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects. [optional] query str The query string to filter results based on SLO names. [optional] tags_query str The query string to filter results based on a single SLO tag. [optional] metrics_query str The query string to filter results based on SLO numerator and denominator. [optional] Return type SLOListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_slo SLOListResponse update_slo(slo_id, body) Update an SLO Update the specified service level objective object. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. body = ServiceLevelObjective( created_at=1, creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], id=\"id_example\", modified_at=1, monitor_ids=[ 1, ], monitor_tags=[ \"monitor_tags_example\", ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjective | The edited service level objective request object. # example passing only required values which don't have defaults set try: # Update an SLO api_response = api_instance.update_slo(slo_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->update_slo: %s\\n\" % e) Parameters Name Type Description Notes slo_id str The ID of the service level objective object. body ServiceLevelObjective The edited service level objective request object. Return type SLOListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.ServiceLevelObjectivesApi"},{"location":"v1/ServiceLevelObjectivesApi/#datadog_api_clientv1servicelevelobjectivesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description check_can_delete_slo GET /api/v1/slo/can_delete Check if SLOs can be safely deleted create_slo POST /api/v1/slo Create an SLO object delete_slo DELETE /api/v1/slo/{slo_id} Delete an SLO delete_slo_timeframe_in_bulk POST /api/v1/slo/bulk_delete Bulk Delete SLO Timeframes get_slo GET /api/v1/slo/{slo_id} Get an SLO's details get_slo_history GET /api/v1/slo/{slo_id}/history Get an SLO's history list_slos GET /api/v1/slo Get all SLOs update_slo PUT /api/v1/slo/{slo_id} Update an SLO","title":"datadog_api_client.v1.ServiceLevelObjectivesApi"},{"location":"v1/ServiceLevelObjectivesApi/#check_can_delete_slo","text":"CheckCanDeleteSLOResponse check_can_delete_slo(ids) Check if SLOs can be safely deleted Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard.","title":"check_can_delete_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. # example passing only required values which don't have defaults set try: # Check if SLOs can be safely deleted api_response = api_instance.check_can_delete_slo(ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->check_can_delete_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters","text":"Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type","text":"CheckCanDeleteSLOResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#create_slo","text":"SLOListResponse create_slo(body) Create an SLO object Create a service level objective object.","title":"create_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = ServiceLevelObjectiveRequest( description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], monitor_ids=[ 1, ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjectiveRequest | Service level objective request object. # example passing only required values which don't have defaults set try: # Create an SLO object api_response = api_instance.create_slo(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->create_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_1","text":"Name Type Description Notes body ServiceLevelObjectiveRequest Service level objective request object.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_1","text":"SLOListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#delete_slo","text":"SLODeleteResponse delete_slo(slo_id) Delete an SLO Permanently delete the specified service level objective object. If an SLO is used in a dashboard, the DELETE /v1/slo/ endpoint returns a 409 conflict error because the SLO is referenced in a dashboard.","title":"delete_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective. force = \"force_example\" # str | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). (optional) # example passing only required values which don't have defaults set try: # Delete an SLO api_response = api_instance.delete_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Delete an SLO api_response = api_instance.delete_slo(slo_id, force=force) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_2","text":"Name Type Description Notes slo_id str The ID of the service level objective. force str Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_2","text":"SLODeleteResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#delete_slo_timeframe_in_bulk","text":"SLOBulkDeleteResponse delete_slo_timeframe_in_bulk(body) Bulk Delete SLO Timeframes Delete (or partially delete) multiple service level objective objects. This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well.","title":"delete_slo_timeframe_in_bulk"},{"location":"v1/ServiceLevelObjectivesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) body = SLOBulkDelete( key=[ SLOTimeframe(\"7d\"), ], ) # SLOBulkDelete | Delete multiple service level objective objects request body. # example passing only required values which don't have defaults set try: # Bulk Delete SLO Timeframes api_response = api_instance.delete_slo_timeframe_in_bulk(body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->delete_slo_timeframe_in_bulk: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_3","text":"Name Type Description Notes body SLOBulkDelete Delete multiple service level objective objects request body.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_3","text":"SLOBulkDeleteResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#get_slo","text":"SLOResponse get_slo(slo_id) Get an SLO's details Get a service level objective object.","title":"get_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. with_configured_alert_ids = True # bool | Get the IDs of SLO monitors that reference this SLO. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's details api_response = api_instance.get_slo(slo_id) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's details api_response = api_instance.get_slo(slo_id, with_configured_alert_ids=with_configured_alert_ids) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_4","text":"Name Type Description Notes slo_id str The ID of the service level objective object. with_configured_alert_ids bool Get the IDs of SLO monitors that reference this SLO. [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_4","text":"SLOResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#get_slo_history","text":"SLOHistoryResponse get_slo_history(slo_id, from_ts, to_ts) Get an SLO's history Get a specific SLO\u2019s history, regardless of its SLO type. The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history. Note: There are different response formats for event based and time based SLOs. Examples of both are shown.","title":"get_slo_history"},{"location":"v1/ServiceLevelObjectivesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_slo_history\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. from_ts = 1 # int | The `from` timestamp for the query window in epoch seconds. to_ts = 1 # int | The `to` timestamp for the query window in epoch seconds. target = 0 # float | The SLO target. If `target` is passed in, the response will include the error budget that remains. (optional) # example passing only required values which don't have defaults set try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an SLO's history api_response = api_instance.get_slo_history(slo_id, from_ts, to_ts, target=target) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_5","text":"Name Type Description Notes slo_id str The ID of the service level objective object. from_ts int The `from` timestamp for the query window in epoch seconds. to_ts int 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 error budget that remains. [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_5","text":"SLOHistoryResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#list_slos","text":"SLOListResponse list_slos() Get all SLOs Get a list of service level objective objects for your organization.","title":"list_slos"},{"location":"v1/ServiceLevelObjectivesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) ids = \"id1, id2, id3\" # str | A comma separated list of the IDs of the service level objectives objects. (optional) query = \"monitor\" # str | The query string to filter results based on SLO names. (optional) tags_query = \"env:prod\" # str | The query string to filter results based on a single SLO tag. (optional) metrics_query = \"aws.elb.request_count\" # str | The query string to filter results based on SLO numerator and denominator. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all SLOs api_response = api_instance.list_slos(ids=ids, query=query, tags_query=tags_query, metrics_query=metrics_query) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->list_slos: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_6","text":"Name Type Description Notes ids str A comma separated list of the IDs of the service level objectives objects. [optional] query str The query string to filter results based on SLO names. [optional] tags_query str The query string to filter results based on a single SLO tag. [optional] metrics_query str The query string to filter results based on SLO numerator and denominator. [optional]","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_6","text":"SLOListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceLevelObjectivesApi/#update_slo","text":"SLOListResponse update_slo(slo_id, body) Update an SLO Update the specified service level objective object.","title":"update_slo"},{"location":"v1/ServiceLevelObjectivesApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import service_level_objectives_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = service_level_objectives_api.ServiceLevelObjectivesApi(api_client) slo_id = \"slo_id_example\" # str | The ID of the service level objective object. body = ServiceLevelObjective( created_at=1, creator=Creator( email=\"email_example\", handle=\"handle_example\", name=\"name_example\", ), description=\"description_example\", groups=[\"env:prod\",\"role:mysql\"], id=\"id_example\", modified_at=1, monitor_ids=[ 1, ], monitor_tags=[ \"monitor_tags_example\", ], name=\"Custom Metric SLO\", query=ServiceLevelObjectiveQuery( denominator=\"sum:my.custom.metric{*}.as_count()\", numerator=\"sum:my.custom.metric{type:good}.as_count()\", ), tags=[\"env:prod\",\"app:core\"], thresholds=[ SLOThreshold( target=99.9, target_display=\"99.9\", timeframe=SLOTimeframe(\"7d\"), warning=90.0, warning_display=\"90.0\", ), ], type=SLOType(\"metric\"), ) # ServiceLevelObjective | The edited service level objective request object. # example passing only required values which don't have defaults set try: # Update an SLO api_response = api_instance.update_slo(slo_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling ServiceLevelObjectivesApi->update_slo: %s\\n\" % e)","title":"Example"},{"location":"v1/ServiceLevelObjectivesApi/#parameters_7","text":"Name Type Description Notes slo_id str The ID of the service level objective object. body ServiceLevelObjective The edited service level objective request object.","title":"Parameters"},{"location":"v1/ServiceLevelObjectivesApi/#return-type_7","text":"SLOListResponse","title":"Return type"},{"location":"v1/ServiceLevelObjectivesApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/ServiceLevelObjectivesApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/ServiceLevelObjectivesApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/ServiceMapWidgetDefinition/","text":"ServiceMapWidgetDefinition This widget displays a map of a service to all of the services that call it, and all of the services that it calls. Properties Name Type Description Notes filters [str] Your environment and primary tag (or * if enabled for your account). service str The ID of the service you want to map. type ServiceMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceMapWidgetDefinition"},{"location":"v1/ServiceMapWidgetDefinition/#servicemapwidgetdefinition","text":"This widget displays a map of a service to all of the services that call it, and all of the services that it calls.","title":"ServiceMapWidgetDefinition"},{"location":"v1/ServiceMapWidgetDefinition/#properties","text":"Name Type Description Notes filters [str] Your environment and primary tag (or * if enabled for your account). service str The ID of the service you want to map. type ServiceMapWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] title str The title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceMapWidgetDefinitionType/","text":"ServiceMapWidgetDefinitionType Type of the service map widget. Properties Name Type Description Notes value str Type of the service map widget. defaults to \"servicemap\", must be one of [\"servicemap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceMapWidgetDefinitionType"},{"location":"v1/ServiceMapWidgetDefinitionType/#servicemapwidgetdefinitiontype","text":"Type of the service map widget.","title":"ServiceMapWidgetDefinitionType"},{"location":"v1/ServiceMapWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the service map widget. defaults to \"servicemap\", must be one of [\"servicemap\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceSummaryWidgetDefinition/","text":"ServiceSummaryWidgetDefinition The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards. Properties Name Type Description Notes env str APM environment. service str APM service. span_name str APM span name. type ServiceSummaryWidgetDefinitionType display_format WidgetServiceSummaryDisplayFormat [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceSummaryWidgetDefinition"},{"location":"v1/ServiceSummaryWidgetDefinition/#servicesummarywidgetdefinition","text":"The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.","title":"ServiceSummaryWidgetDefinition"},{"location":"v1/ServiceSummaryWidgetDefinition/#properties","text":"Name Type Description Notes env str APM environment. service str APM service. span_name str APM span name. type ServiceSummaryWidgetDefinitionType display_format WidgetServiceSummaryDisplayFormat [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] time WidgetTime [optional] title str Title of the widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ServiceSummaryWidgetDefinitionType/","text":"ServiceSummaryWidgetDefinitionType Type of the service summary widget. Properties Name Type Description Notes value str Type of the service summary widget. defaults to \"trace_service\", must be one of [\"trace_service\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ServiceSummaryWidgetDefinitionType"},{"location":"v1/ServiceSummaryWidgetDefinitionType/#servicesummarywidgetdefinitiontype","text":"Type of the service summary widget.","title":"ServiceSummaryWidgetDefinitionType"},{"location":"v1/ServiceSummaryWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the service summary widget. defaults to \"trace_service\", must be one of [\"trace_service\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SlackIntegrationApi/","text":"datadog_api_client.v1.SlackIntegrationApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel 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 GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration 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 PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel create_slack_integration_channel SlackIntegrationChannel create_slack_integration_channel(account_name, body) Create a Slack integration channel Add a channel to your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing Slack channel to be created # example passing only required values which don't have defaults set try: # Create a Slack integration channel api_response = api_instance.create_slack_integration_channel(account_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->create_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. body SlackIntegrationChannel Payload describing Slack channel to be created Return type SlackIntegrationChannel Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slack_integration_channel SlackIntegrationChannel get_slack_integration_channel(account_name, channel_name) Get a Slack integration channel Get a channel configured for your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Get a Slack integration channel api_response = api_instance.get_slack_integration_channel(account_name, channel_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. Return type SlackIntegrationChannel Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_slack_integration_channels SlackIntegrationChannels get_slack_integration_channels(account_name) Get all channels in a Slack integration Get a list of all channels configured for your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. # example passing only required values which don't have defaults set try: # Get all channels in a Slack integration api_response = api_instance.get_slack_integration_channels(account_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channels: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. Return type SlackIntegrationChannels Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_slack_integration_channel remove_slack_integration_channel(account_name, channel_name) Remove a Slack integration channel Remove a channel from your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Remove a Slack integration channel api_instance.remove_slack_integration_channel(account_name, channel_name) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->remove_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 The channel was removed successfully. - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_slack_integration_channel SlackIntegrationChannel update_slack_integration_channel(account_name, channel_name, body) Update a Slack integration channel Update a channel used in your Datadog-Slack integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing fields and values to be updated. # example passing only required values which don't have defaults set try: # Update a Slack integration channel api_response = api_instance.update_slack_integration_channel(account_name, channel_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->update_slack_integration_channel: %s\\n\" % e) Parameters Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. body SlackIntegrationChannel Payload describing fields and values to be updated. Return type SlackIntegrationChannel Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.SlackIntegrationApi"},{"location":"v1/SlackIntegrationApi/#datadog_api_clientv1slackintegrationapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_slack_integration_channel POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels Create a Slack integration channel 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 GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels Get all channels in a Slack integration 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 PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} Update a Slack integration channel","title":"datadog_api_client.v1.SlackIntegrationApi"},{"location":"v1/SlackIntegrationApi/#create_slack_integration_channel","text":"SlackIntegrationChannel create_slack_integration_channel(account_name, body) Create a Slack integration channel Add a channel to your Datadog-Slack integration.","title":"create_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing Slack channel to be created # example passing only required values which don't have defaults set try: # Create a Slack integration channel api_response = api_instance.create_slack_integration_channel(account_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->create_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters","text":"Name Type Description Notes account_name str Your Slack account name. body SlackIntegrationChannel Payload describing Slack channel to be created","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type","text":"SlackIntegrationChannel","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#get_slack_integration_channel","text":"SlackIntegrationChannel get_slack_integration_channel(account_name, channel_name) Get a Slack integration channel Get a channel configured for your Datadog-Slack integration.","title":"get_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Get a Slack integration channel api_response = api_instance.get_slack_integration_channel(account_name, channel_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_1","text":"Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_1","text":"SlackIntegrationChannel","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#get_slack_integration_channels","text":"SlackIntegrationChannels get_slack_integration_channels(account_name) Get all channels in a Slack integration Get a list of all channels configured for your Datadog-Slack integration.","title":"get_slack_integration_channels"},{"location":"v1/SlackIntegrationApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. # example passing only required values which don't have defaults set try: # Get all channels in a Slack integration api_response = api_instance.get_slack_integration_channels(account_name) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->get_slack_integration_channels: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_2","text":"Name Type Description Notes account_name str Your Slack account name.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_2","text":"SlackIntegrationChannels","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#remove_slack_integration_channel","text":"remove_slack_integration_channel(account_name, channel_name) Remove a Slack integration channel Remove a channel from your Datadog-Slack integration.","title":"remove_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. # example passing only required values which don't have defaults set try: # Remove a Slack integration channel api_instance.remove_slack_integration_channel(account_name, channel_name) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->remove_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_3","text":"Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_3","text":"Status code Description Response headers 204 The channel was removed successfully. - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationApi/#update_slack_integration_channel","text":"SlackIntegrationChannel update_slack_integration_channel(account_name, channel_name, body) Update a Slack integration channel Update a channel used in your Datadog-Slack integration.","title":"update_slack_integration_channel"},{"location":"v1/SlackIntegrationApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import slack_integration_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = slack_integration_api.SlackIntegrationApi(api_client) account_name = \"account_name_example\" # str | Your Slack account name. channel_name = \"channel_name_example\" # str | The name of the Slack channel being operated on. body = SlackIntegrationChannel( display=SlackIntegrationChannelDisplay( message=True, notified=True, snapshot=True, tags=True, ), name=\"#general\", ) # SlackIntegrationChannel | Payload describing fields and values to be updated. # example passing only required values which don't have defaults set try: # Update a Slack integration channel api_response = api_instance.update_slack_integration_channel(account_name, channel_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SlackIntegrationApi->update_slack_integration_channel: %s\\n\" % e)","title":"Example"},{"location":"v1/SlackIntegrationApi/#parameters_4","text":"Name Type Description Notes account_name str Your Slack account name. channel_name str The name of the Slack channel being operated on. body SlackIntegrationChannel Payload describing fields and values to be updated.","title":"Parameters"},{"location":"v1/SlackIntegrationApi/#return-type_4","text":"SlackIntegrationChannel","title":"Return type"},{"location":"v1/SlackIntegrationApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SlackIntegrationApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SlackIntegrationApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Item Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SlackIntegrationChannel/","text":"SlackIntegrationChannel The Slack channel configuration. Properties Name Type Description Notes display SlackIntegrationChannelDisplay [optional] name str Your channel name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SlackIntegrationChannel"},{"location":"v1/SlackIntegrationChannel/#slackintegrationchannel","text":"The Slack channel configuration.","title":"SlackIntegrationChannel"},{"location":"v1/SlackIntegrationChannel/#properties","text":"Name Type Description Notes display SlackIntegrationChannelDisplay [optional] name str Your channel name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SlackIntegrationChannelDisplay/","text":"SlackIntegrationChannelDisplay Configuration options for what is shown in an alert event message. Properties Name Type Description Notes message bool Show the main body of the alert event. [optional] if omitted the server will use the default value of True notified bool Show the list of @-handles in the alert event. [optional] if omitted the server will use the default value of True snapshot bool Show the alert event's snapshot image. [optional] if omitted the server will use the default value of True tags bool Show the scopes on which the monitor alerted. [optional] if omitted the server will use the default value of True [Back to Model list] [Back to API list] [Back to README]","title":"SlackIntegrationChannelDisplay"},{"location":"v1/SlackIntegrationChannelDisplay/#slackintegrationchanneldisplay","text":"Configuration options for what is shown in an alert event message.","title":"SlackIntegrationChannelDisplay"},{"location":"v1/SlackIntegrationChannelDisplay/#properties","text":"Name Type Description Notes message bool Show the main body of the alert event. [optional] if omitted the server will use the default value of True notified bool Show the list of @-handles in the alert event. [optional] if omitted the server will use the default value of True snapshot bool Show the alert event's snapshot image. [optional] if omitted the server will use the default value of True tags bool Show the scopes on which the monitor alerted. [optional] if omitted the server will use the default value of True [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SlackIntegrationChannels/","text":"SlackIntegrationChannels A list of configured Slack channels. Properties Name Type Description Notes value [SlackIntegrationChannel] A list of configured Slack channels. [Back to Model list] [Back to API list] [Back to README]","title":"SlackIntegrationChannels"},{"location":"v1/SlackIntegrationChannels/#slackintegrationchannels","text":"A list of configured Slack channels.","title":"SlackIntegrationChannels"},{"location":"v1/SlackIntegrationChannels/#properties","text":"Name Type Description Notes value [SlackIntegrationChannel] A list of configured Slack channels. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SnapshotsApi/","text":"datadog_api_client.v1.SnapshotsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots get_graph_snapshot GraphSnapshot get_graph_snapshot(start, end) Take graph snapshots Take graph snapshots. Note : When a snapshot is created, there is some delay before it is available. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import snapshots_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = snapshots_api.SnapshotsApi(api_client) start = 1 # int | The POSIX timestamp of the start of the query. end = 1 # int | The POSIX timestamp of the end of the query. metric_query = \"metric_query_example\" # str | The metric query. (optional) event_query = \"event_query_example\" # str | A query that adds event bands to the graph. (optional) graph_def = \"graph_def_example\" # str | 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 = \"title_example\" # str | A title for the graph. If no title is specified, the graph does not have a title. (optional) # example passing only required values which don't have defaults set try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end, metric_query=metric_query, event_query=event_query, graph_def=graph_def, title=title) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e) Parameters Name Type Description Notes start int The POSIX timestamp of the start of the query. end int The POSIX timestamp of the end of the query. metric_query str The metric query. [optional] event_query str A query that adds event bands to the graph. [optional] graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] title str A title for the graph. If no title is specified, the graph does not have a title. [optional] Return type GraphSnapshot Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.SnapshotsApi"},{"location":"v1/SnapshotsApi/#datadog_api_clientv1snapshotsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_graph_snapshot GET /api/v1/graph/snapshot Take graph snapshots","title":"datadog_api_client.v1.SnapshotsApi"},{"location":"v1/SnapshotsApi/#get_graph_snapshot","text":"GraphSnapshot get_graph_snapshot(start, end) Take graph snapshots Take graph snapshots. Note : When a snapshot is created, there is some delay before it is available.","title":"get_graph_snapshot"},{"location":"v1/SnapshotsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import snapshots_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = snapshots_api.SnapshotsApi(api_client) start = 1 # int | The POSIX timestamp of the start of the query. end = 1 # int | The POSIX timestamp of the end of the query. metric_query = \"metric_query_example\" # str | The metric query. (optional) event_query = \"event_query_example\" # str | A query that adds event bands to the graph. (optional) graph_def = \"graph_def_example\" # str | 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 = \"title_example\" # str | A title for the graph. If no title is specified, the graph does not have a title. (optional) # example passing only required values which don't have defaults set try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Take graph snapshots api_response = api_instance.get_graph_snapshot(start, end, metric_query=metric_query, event_query=event_query, graph_def=graph_def, title=title) pprint(api_response) except ApiException as e: print(\"Exception when calling SnapshotsApi->get_graph_snapshot: %s\\n\" % e)","title":"Example"},{"location":"v1/SnapshotsApi/#parameters","text":"Name Type Description Notes start int The POSIX timestamp of the start of the query. end int The POSIX timestamp of the end of the query. metric_query str The metric query. [optional] event_query str A query that adds event bands to the graph. [optional] graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional] title str A title for the graph. If no title is specified, the graph does not have a title. [optional]","title":"Parameters"},{"location":"v1/SnapshotsApi/#return-type","text":"GraphSnapshot","title":"Return type"},{"location":"v1/SnapshotsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SnapshotsApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SnapshotsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsAPIStep/","text":"SyntheticsAPIStep The steps used in a Synthetics multistep API test. Properties Name Type Description Notes allow_failure bool Determines whether or not to continue with test if this step fails. [optional] assertions [SyntheticsAssertion] Array of assertions used for the test. [optional] if omitted the server will use the default value of [] extracted_values [SyntheticsParsingOptions] Array of values to parse and save as variables from the response. [optional] is_critical bool 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 str The name of the step. [optional] request SyntheticsTestRequest [optional] subtype SyntheticsAPIStepSubtype [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPIStep"},{"location":"v1/SyntheticsAPIStep/#syntheticsapistep","text":"The steps used in a Synthetics multistep API test.","title":"SyntheticsAPIStep"},{"location":"v1/SyntheticsAPIStep/#properties","text":"Name Type Description Notes allow_failure bool Determines whether or not to continue with test if this step fails. [optional] assertions [SyntheticsAssertion] Array of assertions used for the test. [optional] if omitted the server will use the default value of [] extracted_values [SyntheticsParsingOptions] Array of values to parse and save as variables from the response. [optional] is_critical bool 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 str The name of the step. [optional] request SyntheticsTestRequest [optional] subtype SyntheticsAPIStepSubtype [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPIStepSubtype/","text":"SyntheticsAPIStepSubtype The subtype of the Synthetic multistep API test step, currently only supporting http . Properties Name Type Description Notes value str The subtype of the Synthetic multistep API test step, currently only supporting `http`. defaults to \"http\", must be one of [\"http\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPIStepSubtype"},{"location":"v1/SyntheticsAPIStepSubtype/#syntheticsapistepsubtype","text":"The subtype of the Synthetic multistep API test step, currently only supporting http .","title":"SyntheticsAPIStepSubtype"},{"location":"v1/SyntheticsAPIStepSubtype/#properties","text":"Name Type Description Notes value str The subtype of the Synthetic multistep API test step, currently only supporting `http`. defaults to \"http\", must be one of [\"http\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITest/","text":"SyntheticsAPITest Object containing details about a Synthetic API test. Properties Name Type Description Notes config SyntheticsAPITestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID for the test. [optional] status SyntheticsTestPauseStatus [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsAPITestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITest"},{"location":"v1/SyntheticsAPITest/#syntheticsapitest","text":"Object containing details about a Synthetic API test.","title":"SyntheticsAPITest"},{"location":"v1/SyntheticsAPITest/#properties","text":"Name Type Description Notes config SyntheticsAPITestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID for the test. [optional] status SyntheticsTestPauseStatus [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsAPITestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestConfig/","text":"SyntheticsAPITestConfig Configuration object for a Synthetic API test. Properties Name Type Description Notes assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] Array of variables used for the test. [optional] request SyntheticsTestRequest [optional] steps [SyntheticsAPIStep] When the test subtype is `multi`, the steps of the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestConfig"},{"location":"v1/SyntheticsAPITestConfig/#syntheticsapitestconfig","text":"Configuration object for a Synthetic API test.","title":"SyntheticsAPITestConfig"},{"location":"v1/SyntheticsAPITestConfig/#properties","text":"Name Type Description Notes assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] Array of variables used for the test. [optional] request SyntheticsTestRequest [optional] steps [SyntheticsAPIStep] When the test subtype is `multi`, the steps of the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultData/","text":"SyntheticsAPITestResultData Object containing results for your Synthetic API test. Properties Name Type Description Notes cert SyntheticsSSLCertificate [optional] error_code SyntheticsErrorCode [optional] error_message str The API test error message. [optional] event_type SyntheticsTestProcessStatus [optional] http_status_code int The API test HTTP status code. [optional] request_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Request header object used for the API test. [optional] response_body str Response body returned for the API test. [optional] response_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Response headers returned for the API test. [optional] response_size int Global size in byte of the API test response. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultData"},{"location":"v1/SyntheticsAPITestResultData/#syntheticsapitestresultdata","text":"Object containing results for your Synthetic API test.","title":"SyntheticsAPITestResultData"},{"location":"v1/SyntheticsAPITestResultData/#properties","text":"Name Type Description Notes cert SyntheticsSSLCertificate [optional] error_code SyntheticsErrorCode [optional] error_message str The API test error message. [optional] event_type SyntheticsTestProcessStatus [optional] http_status_code int The API test HTTP status code. [optional] request_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Request header object used for the API test. [optional] response_body str Response body returned for the API test. [optional] response_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Response headers returned for the API test. [optional] response_size int Global size in byte of the API test response. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultFull/","text":"SyntheticsAPITestResultFull Object returned describing a API test result. Properties Name Type Description Notes check SyntheticsAPITestResultFullCheck [optional] check_time float When the API test was conducted. [optional] check_version int Version of the API test used. [optional] probe_dc str Locations for which to query the API test results. [optional] result SyntheticsAPITestResultData [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultFull"},{"location":"v1/SyntheticsAPITestResultFull/#syntheticsapitestresultfull","text":"Object returned describing a API test result.","title":"SyntheticsAPITestResultFull"},{"location":"v1/SyntheticsAPITestResultFull/#properties","text":"Name Type Description Notes check SyntheticsAPITestResultFullCheck [optional] check_time float When the API test was conducted. [optional] check_version int Version of the API test used. [optional] probe_dc str Locations for which to query the API test results. [optional] result SyntheticsAPITestResultData [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultFullCheck/","text":"SyntheticsAPITestResultFullCheck Object describing the API test configuration. Properties Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultFullCheck"},{"location":"v1/SyntheticsAPITestResultFullCheck/#syntheticsapitestresultfullcheck","text":"Object describing the API test configuration.","title":"SyntheticsAPITestResultFullCheck"},{"location":"v1/SyntheticsAPITestResultFullCheck/#properties","text":"Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultShort/","text":"SyntheticsAPITestResultShort Object with the results of a single Synthetic API test. Properties Name Type Description Notes check_time float Last time the API test was performed. [optional] probe_dc str Location from which the API test was performed. [optional] result SyntheticsAPITestResultShortResult [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultShort"},{"location":"v1/SyntheticsAPITestResultShort/#syntheticsapitestresultshort","text":"Object with the results of a single Synthetic API test.","title":"SyntheticsAPITestResultShort"},{"location":"v1/SyntheticsAPITestResultShort/#properties","text":"Name Type Description Notes check_time float Last time the API test was performed. [optional] probe_dc str Location from which the API test was performed. [optional] result SyntheticsAPITestResultShortResult [optional] result_id str ID of the API test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestResultShortResult/","text":"SyntheticsAPITestResultShortResult Result of the last API test run. Properties Name Type Description Notes passed bool Describes if the test run has passed or failed. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestResultShortResult"},{"location":"v1/SyntheticsAPITestResultShortResult/#syntheticsapitestresultshortresult","text":"Result of the last API test run.","title":"SyntheticsAPITestResultShortResult"},{"location":"v1/SyntheticsAPITestResultShortResult/#properties","text":"Name Type Description Notes passed bool Describes if the test run has passed or failed. [optional] timings SyntheticsTiming [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAPITestType/","text":"SyntheticsAPITestType Type of the Synthetic test, api . Properties Name Type Description Notes value str Type of the Synthetic test, `api`. defaults to \"api\", must be one of [\"api\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAPITestType"},{"location":"v1/SyntheticsAPITestType/#syntheticsapitesttype","text":"Type of the Synthetic test, api .","title":"SyntheticsAPITestType"},{"location":"v1/SyntheticsAPITestType/#properties","text":"Name Type Description Notes value str Type of the Synthetic test, `api`. defaults to \"api\", must be one of [\"api\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsApi/","text":"datadog_api_client.v1.SyntheticsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_global_variable POST /api/v1/synthetics/variables Create a global variable create_private_location POST /api/v1/synthetics/private-locations Create a private location create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location delete_tests POST /api/v1/synthetics/tests/delete Delete tests edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test 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 GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test 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 GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration list_locations GET /api/v1/synthetics/locations Get all locations (public and private) list_tests GET /api/v1/synthetics/tests Get the list of all tests trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test create_global_variable SyntheticsGlobalVariable create_global_variable(body) Create a global variable Create a Synthetics global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to create. # example passing only required values which don't have defaults set try: # Create a global variable api_response = api_instance.create_global_variable(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_global_variable: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsGlobalVariable Details of the global variable to create. Return type SyntheticsGlobalVariable Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_private_location SyntheticsPrivateLocationCreationResponse create_private_location(body) Create a private location Create a new Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to create. # example passing only required values which don't have defaults set try: # Create a private location api_response = api_instance.create_private_location(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_private_location: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsPrivateLocation Details of the private location to create. Return type SyntheticsPrivateLocationCreationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 402 Quota reached for private locations - 404 Private locations are not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_synthetics_api_test SyntheticsAPITest create_synthetics_api_test(body) Create an API test Create a Synthetic API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create an API test api_response = api_instance.create_synthetics_api_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_api_test: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsAPITest Details of the test to create. Return type SyntheticsAPITest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_synthetics_browser_test SyntheticsBrowserTest create_synthetics_browser_test(body) Create a browser test Create a Synthetic browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create a browser test api_response = api_instance.create_synthetics_browser_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_browser_test: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsBrowserTest Details of the test to create. Return type SyntheticsBrowserTest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_global_variable delete_global_variable(variable_id) Delete a global variable Delete a Synthetics global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Delete a global variable api_instance.delete_global_variable(variable_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_global_variable: %s\\n\" % e) Parameters Name Type Description Notes variable_id str The ID of the global variable. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 JSON format is wrong - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_private_location delete_private_location(location_id) Delete a private location Delete a Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Delete a private location api_instance.delete_private_location(location_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_private_location: %s\\n\" % e) Parameters Name Type Description Notes location_id str The ID of the private location. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_tests SyntheticsDeleteTestsResponse delete_tests(body) Delete tests Delete multiple Synthetic tests by ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsDeleteTestsPayload( public_ids=[], ) # SyntheticsDeleteTestsPayload | Public ID list of the Synthetic tests to be deleted. # example passing only required values which don't have defaults set try: # Delete tests api_response = api_instance.delete_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_tests: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsDeleteTestsPayload Public ID list of the Synthetic tests to be deleted. Return type SyntheticsDeleteTestsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK. - 400 - JSON format is wrong - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) - Some IDs are not owned by the user - 403 Forbidden - 404 - Tests to be deleted can't be found - Synthetics is not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] edit_global_variable SyntheticsGlobalVariable edit_global_variable(variable_id, body) Edit a global variable Edit a Synthetics global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to update. # example passing only required values which don't have defaults set try: # Edit a global variable api_response = api_instance.edit_global_variable(variable_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->edit_global_variable: %s\\n\" % e) Parameters Name Type Description Notes variable_id str The ID of the global variable. body SyntheticsGlobalVariable Details of the global variable to update. Return type SyntheticsGlobalVariable Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_test SyntheticsAPITest get_api_test(public_id) Get an API test Get the detailed configuration associated with a Synthetic API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get an API test api_response = api_instance.get_api_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. Return type SyntheticsAPITest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_test_latest_results SyntheticsGetAPITestLatestResultsResponse get_api_test_latest_results(public_id) Get an API test's latest results summaries Get the last 50 test results summaries for a given Synthetics API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional] Return type SyntheticsGetAPITestLatestResultsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_test_result SyntheticsAPITestResultFull get_api_test_result(public_id, result_id) Get an API test result Get a specific full result from a given (API) Synthetic test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the API test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get an API test result api_response = api_instance.get_api_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_result: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the API test to which the target result belongs. result_id str The ID of the result to get. Return type SyntheticsAPITestResultFull Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_browser_test SyntheticsBrowserTest get_browser_test(public_id) Get a browser test Get the detailed configuration (including steps) associated with a Synthetic browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a browser test api_response = api_instance.get_browser_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. Return type SyntheticsBrowserTest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_browser_test_latest_results SyntheticsGetBrowserTestLatestResultsResponse get_browser_test_latest_results(public_id) Get a browser test's latest results summaries Get the last 50 test results summaries for a given Synthetics Browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the browser test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional] Return type SyntheticsGetBrowserTestLatestResultsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_browser_test_result SyntheticsBrowserTestResultFull get_browser_test_result(public_id, result_id) Get a browser test result Get a specific full result from a given (browser) Synthetic test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get a browser test result api_response = api_instance.get_browser_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_result: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the browser test to which the target result belongs. result_id str The ID of the result to get. Return type SyntheticsBrowserTestResultFull Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_global_variable SyntheticsGlobalVariable get_global_variable(variable_id) Get a global variable Get the detailed configuration of a global variable. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Get a global variable api_response = api_instance.get_global_variable(variable_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_global_variable: %s\\n\" % e) Parameters Name Type Description Notes variable_id str The ID of the global variable. Return type SyntheticsGlobalVariable Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_private_location SyntheticsPrivateLocation get_private_location(location_id) Get a private location Get a Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Get a private location api_response = api_instance.get_private_location(location_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_private_location: %s\\n\" % e) Parameters Name Type Description Notes location_id str The ID of the private location. Return type SyntheticsPrivateLocation Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 404 - Synthetic private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_test SyntheticsTestDetails get_test(public_id) Get a test configuration Get the detailed configuration associated with a Synthetics test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a test configuration api_response = api_instance.get_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. Return type SyntheticsTestDetails Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_locations SyntheticsLocations list_locations() Get all locations (public and private) Get the list of public and private locations available for Synthetic tests. No arguments required. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all locations (public and private) api_response = api_instance.list_locations() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_locations: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type SyntheticsLocations Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tests SyntheticsListTestsResponse list_tests() Get the list of all tests Get the list of all Synthetic tests. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get the list of all tests api_response = api_instance.list_tests() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_tests: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type SyntheticsListTestsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns the list of all Synthetic tests. - 403 Forbidden - 404 Synthetics is not activated for the user. - [Back to top] [Back to API list] [Back to Model list] [Back to README] trigger_ci_tests SyntheticsTriggerCITestsResponse trigger_ci_tests(body) Trigger tests from CI/CD pipelines Trigger a set of Synthetics tests for continuous integration. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsCITestBody( tests=[ SyntheticsCITest( allow_insecure_certificates=True, basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", body_type=\"body_type_example\", cookies=\"cookies_example\", device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], follow_redirects=True, headers=SyntheticsTestHeaders( key=\"key_example\", ), locations=[ \"locations_example\", ], metadata=SyntheticsCITestMetadata( ci=SyntheticsCITestMetadataCi( pipeline=\"pipeline_example\", provider=\"provider_example\", ), git=SyntheticsCITestMetadataGit( branch=\"branch_example\", commit_sha=\"commit_sha_example\", ), ), public_id=\"aaa-aaa-aaa\", retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), start_url=\"start_url_example\", variables={ \"key\": \"key_example\", }, ), ], ) # SyntheticsCITestBody | Details of the test to trigger. # example passing only required values which don't have defaults set try: # Trigger tests from CI/CD pipelines api_response = api_instance.trigger_ci_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->trigger_ci_tests: %s\\n\" % e) Parameters Name Type Description Notes body SyntheticsCITestBody Details of the test to trigger. Return type SyntheticsTriggerCITestsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 JSON format is wrong - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_api_test SyntheticsAPITest update_api_test(public_id, body) Edit an API test Edit the configuration of a Synthetic API test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit an API test api_response = api_instance.update_api_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_api_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsAPITest New test details to be saved. Return type SyntheticsAPITest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_browser_test SyntheticsBrowserTest update_browser_test(public_id, body) Edit a browser test Edit the configuration of a Synthetic browser test. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit a browser test api_response = api_instance.update_browser_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_browser_test: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsBrowserTest New test details to be saved. Return type SyntheticsBrowserTest Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_private_location SyntheticsPrivateLocation update_private_location(location_id, body) Edit a private location Edit a Synthetics private location. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to be updated. # example passing only required values which don't have defaults set try: # Edit a private location api_response = api_instance.update_private_location(location_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_private_location: %s\\n\" % e) Parameters Name Type Description Notes location_id str The ID of the private location. body SyntheticsPrivateLocation Details of the private location to be updated. Return type SyntheticsPrivateLocation Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_test_pause_status bool update_test_pause_status(public_id, body) Pause or start a test Pause or start a Synthetics test by changing the status. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the Synthetic test to update. body = SyntheticsUpdateTestPauseStatusPayload( new_status=SyntheticsTestPauseStatus(\"live\"), ) # SyntheticsUpdateTestPauseStatusPayload | Status to set the given Synthetic test to. # example passing only required values which don't have defaults set try: # Pause or start a test api_response = api_instance.update_test_pause_status(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_test_pause_status: %s\\n\" % e) Parameters Name Type Description Notes public_id str The public ID of the Synthetic test to update. body SyntheticsUpdateTestPauseStatusPayload Status to set the given Synthetic test to. Return type bool Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - Returns a boolean indicating if the update was successful. - 400 JSON format is wrong. - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.SyntheticsApi"},{"location":"v1/SyntheticsApi/#datadog_api_clientv1syntheticsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_global_variable POST /api/v1/synthetics/variables Create a global variable create_private_location POST /api/v1/synthetics/private-locations Create a private location create_synthetics_api_test POST /api/v1/synthetics/tests/api Create an API test create_synthetics_browser_test POST /api/v1/synthetics/tests/browser Create a browser test delete_global_variable DELETE /api/v1/synthetics/variables/{variable_id} Delete a global variable delete_private_location DELETE /api/v1/synthetics/private-locations/{location_id} Delete a private location delete_tests POST /api/v1/synthetics/tests/delete Delete tests edit_global_variable PUT /api/v1/synthetics/variables/{variable_id} Edit a global variable get_api_test GET /api/v1/synthetics/tests/api/{public_id} Get an API test 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 GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get an API test result get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a browser test 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 GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a browser test result get_global_variable GET /api/v1/synthetics/variables/{variable_id} Get a global variable get_private_location GET /api/v1/synthetics/private-locations/{location_id} Get a private location get_test GET /api/v1/synthetics/tests/{public_id} Get a test configuration list_locations GET /api/v1/synthetics/locations Get all locations (public and private) list_tests GET /api/v1/synthetics/tests Get the list of all tests trigger_ci_tests POST /api/v1/synthetics/tests/trigger/ci Trigger tests from CI/CD pipelines update_api_test PUT /api/v1/synthetics/tests/api/{public_id} Edit an API test update_browser_test PUT /api/v1/synthetics/tests/browser/{public_id} Edit a browser test update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location update_test_pause_status PUT /api/v1/synthetics/tests/{public_id}/status Pause or start a test","title":"datadog_api_client.v1.SyntheticsApi"},{"location":"v1/SyntheticsApi/#create_global_variable","text":"SyntheticsGlobalVariable create_global_variable(body) Create a global variable Create a Synthetics global variable.","title":"create_global_variable"},{"location":"v1/SyntheticsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to create. # example passing only required values which don't have defaults set try: # Create a global variable api_response = api_instance.create_global_variable(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters","text":"Name Type Description Notes body SyntheticsGlobalVariable Details of the global variable to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type","text":"SyntheticsGlobalVariable","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#create_private_location","text":"SyntheticsPrivateLocationCreationResponse create_private_location(body) Create a private location Create a new Synthetics private location.","title":"create_private_location"},{"location":"v1/SyntheticsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to create. # example passing only required values which don't have defaults set try: # Create a private location api_response = api_instance.create_private_location(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_1","text":"Name Type Description Notes body SyntheticsPrivateLocation Details of the private location to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_1","text":"SyntheticsPrivateLocationCreationResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 402 Quota reached for private locations - 404 Private locations are not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#create_synthetics_api_test","text":"SyntheticsAPITest create_synthetics_api_test(body) Create an API test Create a Synthetic API test.","title":"create_synthetics_api_test"},{"location":"v1/SyntheticsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create an API test api_response = api_instance.create_synthetics_api_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_api_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_2","text":"Name Type Description Notes body SyntheticsAPITest Details of the test to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_2","text":"SyntheticsAPITest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#create_synthetics_browser_test","text":"SyntheticsBrowserTest create_synthetics_browser_test(body) Create a browser test Create a Synthetic browser test.","title":"create_synthetics_browser_test"},{"location":"v1/SyntheticsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | Details of the test to create. # example passing only required values which don't have defaults set try: # Create a browser test api_response = api_instance.create_synthetics_browser_test(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->create_synthetics_browser_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_3","text":"Name Type Description Notes body SyntheticsBrowserTest Details of the test to create.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_3","text":"SyntheticsBrowserTest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#delete_global_variable","text":"delete_global_variable(variable_id) Delete a global variable Delete a Synthetics global variable.","title":"delete_global_variable"},{"location":"v1/SyntheticsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Delete a global variable api_instance.delete_global_variable(variable_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_4","text":"Name Type Description Notes variable_id str The ID of the global variable.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_4","text":"void (empty response body)","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 JSON format is wrong - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#delete_private_location","text":"delete_private_location(location_id) Delete a private location Delete a Synthetics private location.","title":"delete_private_location"},{"location":"v1/SyntheticsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Delete a private location api_instance.delete_private_location(location_id) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_5","text":"Name Type Description Notes location_id str The ID of the private location.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_5","text":"void (empty response body)","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_5","text":"Status code Description Response headers 204 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#delete_tests","text":"SyntheticsDeleteTestsResponse delete_tests(body) Delete tests Delete multiple Synthetic tests by ID.","title":"delete_tests"},{"location":"v1/SyntheticsApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsDeleteTestsPayload( public_ids=[], ) # SyntheticsDeleteTestsPayload | Public ID list of the Synthetic tests to be deleted. # example passing only required values which don't have defaults set try: # Delete tests api_response = api_instance.delete_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->delete_tests: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_6","text":"Name Type Description Notes body SyntheticsDeleteTestsPayload Public ID list of the Synthetic tests to be deleted.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_6","text":"SyntheticsDeleteTestsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_6","text":"Status code Description Response headers 200 OK. - 400 - JSON format is wrong - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) - Some IDs are not owned by the user - 403 Forbidden - 404 - Tests to be deleted can't be found - Synthetics is not activated for the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#edit_global_variable","text":"SyntheticsGlobalVariable edit_global_variable(variable_id, body) Edit a global variable Edit a Synthetics global variable.","title":"edit_global_variable"},{"location":"v1/SyntheticsApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. body = SyntheticsGlobalVariable( description=\"Example description\", id=\"id_example\", name=\"MY_VARIABLE\", parse_test_options=SyntheticsGlobalVariableParseTestOptions( field=\"content-type\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), parse_test_public_id=\"abc-def-123\", tags=[\"team:front\",\"test:workflow-1\"], value=SyntheticsGlobalVariableValue( secure=True, value=\"example-value\", ), ) # SyntheticsGlobalVariable | Details of the global variable to update. # example passing only required values which don't have defaults set try: # Edit a global variable api_response = api_instance.edit_global_variable(variable_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->edit_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_7","text":"Name Type Description Notes variable_id str The ID of the global variable. body SyntheticsGlobalVariable Details of the global variable to update.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_7","text":"SyntheticsGlobalVariable","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Invalid request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_api_test","text":"SyntheticsAPITest get_api_test(public_id) Get an API test Get the detailed configuration associated with a Synthetic API test.","title":"get_api_test"},{"location":"v1/SyntheticsApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get an API test api_response = api_instance.get_api_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_8","text":"Name Type Description Notes public_id str The public ID of the test to get details from.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_8","text":"SyntheticsAPITest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_api_test_latest_results","text":"SyntheticsGetAPITestLatestResultsResponse get_api_test_latest_results(public_id) Get an API test's latest results summaries Get the last 50 test results summaries for a given Synthetics API test.","title":"get_api_test_latest_results"},{"location":"v1/SyntheticsApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get an API test's latest results summaries api_response = api_instance.get_api_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_latest_results: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_9","text":"Name Type Description Notes public_id str The public ID of the test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional]","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_9","text":"SyntheticsGetAPITestLatestResultsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_9","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_api_test_result","text":"SyntheticsAPITestResultFull get_api_test_result(public_id, result_id) Get an API test result Get a specific full result from a given (API) Synthetic test.","title":"get_api_test_result"},{"location":"v1/SyntheticsApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the API test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get an API test result api_response = api_instance.get_api_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_api_test_result: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_10","text":"Name Type Description Notes public_id str The public ID of the API test to which the target result belongs. result_id str The ID of the result to get.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_10","text":"SyntheticsAPITestResultFull","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_10","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_browser_test","text":"SyntheticsBrowserTest get_browser_test(public_id) Get a browser test Get the detailed configuration (including steps) associated with a Synthetic browser test.","title":"get_browser_test"},{"location":"v1/SyntheticsApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a browser test api_response = api_instance.get_browser_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_11","text":"Name Type Description Notes public_id str The public ID of the test to get details from.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_11","text":"SyntheticsBrowserTest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_11","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_browser_test_latest_results","text":"SyntheticsGetBrowserTestLatestResultsResponse get_browser_test_latest_results(public_id) Get a browser test's latest results summaries Get the last 50 test results summaries for a given Synthetics Browser test.","title":"get_browser_test_latest_results"},{"location":"v1/SyntheticsApi/#example_12","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test for which to search results for. from_ts = 1 # int | Timestamp from which to start querying results. (optional) to_ts = 1 # int | Timestamp up to which to query results. (optional) probe_dc = [ \"probe_dc_example\", ] # [str] | Locations for which to query results. (optional) # example passing only required values which don't have defaults set try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get a browser test's latest results summaries api_response = api_instance.get_browser_test_latest_results(public_id, from_ts=from_ts, to_ts=to_ts, probe_dc=probe_dc) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_12","text":"Name Type Description Notes public_id str The public ID of the browser test for which to search results for. from_ts int Timestamp from which to start querying results. [optional] to_ts int Timestamp up to which to query results. [optional] probe_dc [str] Locations for which to query results. [optional]","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_12","text":"SyntheticsGetBrowserTestLatestResultsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_12","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_12","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_12","text":"Status code Description Response headers 200 OK - 403 forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_browser_test_result","text":"SyntheticsBrowserTestResultFull get_browser_test_result(public_id, result_id) Get a browser test result Get a specific full result from a given (browser) Synthetic test.","title":"get_browser_test_result"},{"location":"v1/SyntheticsApi/#example_13","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the browser test to which the target result belongs. result_id = \"result_id_example\" # str | The ID of the result to get. # example passing only required values which don't have defaults set try: # Get a browser test result api_response = api_instance.get_browser_test_result(public_id, result_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_browser_test_result: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_13","text":"Name Type Description Notes public_id str The public ID of the browser test to which the target result belongs. result_id str The ID of the result to get.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_13","text":"SyntheticsBrowserTestResultFull","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_13","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_13","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_13","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test or result is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_global_variable","text":"SyntheticsGlobalVariable get_global_variable(variable_id) Get a global variable Get the detailed configuration of a global variable.","title":"get_global_variable"},{"location":"v1/SyntheticsApi/#example_14","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) variable_id = \"variable_id_example\" # str | The ID of the global variable. # example passing only required values which don't have defaults set try: # Get a global variable api_response = api_instance.get_global_variable(variable_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_global_variable: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_14","text":"Name Type Description Notes variable_id str The ID of the global variable.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_14","text":"SyntheticsGlobalVariable","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_14","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_14","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_14","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_private_location","text":"SyntheticsPrivateLocation get_private_location(location_id) Get a private location Get a Synthetics private location.","title":"get_private_location"},{"location":"v1/SyntheticsApi/#example_15","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. # example passing only required values which don't have defaults set try: # Get a private location api_response = api_instance.get_private_location(location_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_15","text":"Name Type Description Notes location_id str The ID of the private location.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_15","text":"SyntheticsPrivateLocation","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_15","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_15","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_15","text":"Status code Description Response headers 200 OK - 404 - Synthetic private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#get_test","text":"SyntheticsTestDetails get_test(public_id) Get a test configuration Get the detailed configuration associated with a Synthetics test.","title":"get_test"},{"location":"v1/SyntheticsApi/#example_16","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. # example passing only required values which don't have defaults set try: # Get a test configuration api_response = api_instance.get_test(public_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->get_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_16","text":"Name Type Description Notes public_id str The public ID of the test to get details from.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_16","text":"SyntheticsTestDetails","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_16","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_16","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_16","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#list_locations","text":"SyntheticsLocations list_locations() Get all locations (public and private) Get the list of public and private locations available for Synthetic tests. No arguments required.","title":"list_locations"},{"location":"v1/SyntheticsApi/#example_17","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all locations (public and private) api_response = api_instance.list_locations() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_locations: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_17","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_17","text":"SyntheticsLocations","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_17","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_17","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_17","text":"Status code Description Response headers 200 OK - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#list_tests","text":"SyntheticsListTestsResponse list_tests() Get the list of all tests Get the list of all Synthetic tests.","title":"list_tests"},{"location":"v1/SyntheticsApi/#example_18","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get the list of all tests api_response = api_instance.list_tests() pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->list_tests: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_18","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_18","text":"SyntheticsListTestsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_18","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_18","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_18","text":"Status code Description Response headers 200 OK - Returns the list of all Synthetic tests. - 403 Forbidden - 404 Synthetics is not activated for the user. - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#trigger_ci_tests","text":"SyntheticsTriggerCITestsResponse trigger_ci_tests(body) Trigger tests from CI/CD pipelines Trigger a set of Synthetics tests for continuous integration.","title":"trigger_ci_tests"},{"location":"v1/SyntheticsApi/#example_19","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) body = SyntheticsCITestBody( tests=[ SyntheticsCITest( allow_insecure_certificates=True, basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", body_type=\"body_type_example\", cookies=\"cookies_example\", device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], follow_redirects=True, headers=SyntheticsTestHeaders( key=\"key_example\", ), locations=[ \"locations_example\", ], metadata=SyntheticsCITestMetadata( ci=SyntheticsCITestMetadataCi( pipeline=\"pipeline_example\", provider=\"provider_example\", ), git=SyntheticsCITestMetadataGit( branch=\"branch_example\", commit_sha=\"commit_sha_example\", ), ), public_id=\"aaa-aaa-aaa\", retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), start_url=\"start_url_example\", variables={ \"key\": \"key_example\", }, ), ], ) # SyntheticsCITestBody | Details of the test to trigger. # example passing only required values which don't have defaults set try: # Trigger tests from CI/CD pipelines api_response = api_instance.trigger_ci_tests(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->trigger_ci_tests: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_19","text":"Name Type Description Notes body SyntheticsCITestBody Details of the test to trigger.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_19","text":"SyntheticsTriggerCITestsResponse","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_19","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_19","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_19","text":"Status code Description Response headers 200 OK - 400 JSON format is wrong - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_api_test","text":"SyntheticsAPITest update_api_test(public_id, body) Edit an API test Edit the configuration of a Synthetic API test.","title":"update_api_test"},{"location":"v1/SyntheticsApi/#example_20","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsAPITest( config=SyntheticsAPITestConfig( assertions=[ SyntheticsAssertion(), ], config_variables=[ SyntheticsConfigVariable( example=\"example_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsConfigVariableType(\"text\"), ), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), steps=[ SyntheticsAPIStep( allow_failure=True, assertions=[], extracted_values=[ SyntheticsParsingOptions( field=\"content-type\", name=\"name_example\", parser=SyntheticsVariableParser( type=SyntheticsGlobalVariableParserType(\"raw\"), value=\"value_example\", ), type=SyntheticsGlobalVariableParseTestOptionsType(\"http_body\"), ), ], is_critical=True, name=\"name_example\", request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders(SyntheticsTestHeaders), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), subtype=SyntheticsAPIStepSubtype(\"http\"), ), ], ), locations=[ \"locations_example\", ], message=\"message_example\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), subtype=SyntheticsTestDetailsSubType(\"http\"), tags=[ \"tags_example\", ], type=SyntheticsAPITestType(\"api\"), ) # SyntheticsAPITest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit an API test api_response = api_instance.update_api_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_api_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_20","text":"Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsAPITest New test details to be saved.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_20","text":"SyntheticsAPITest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_20","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_20","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_20","text":"Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_browser_test","text":"SyntheticsBrowserTest update_browser_test(public_id, body) Edit a browser test Edit the configuration of a Synthetic browser test.","title":"update_browser_test"},{"location":"v1/SyntheticsApi/#example_21","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the test to get details from. body = SyntheticsBrowserTest( config=SyntheticsBrowserTestConfig( assertions=[ SyntheticsAssertion(), ], request=SyntheticsTestRequest( basic_auth=SyntheticsBasicAuth( password=\"\", username=\"\", ), body=\"body_example\", certificate=SyntheticsTestRequestCertificate( cert=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), key=SyntheticsTestRequestCertificateItem( content=\"content_example\", filename=\"filename_example\", updated_at=\"updated_at_example\", ), ), dns_server=\"dns_server_example\", dns_server_port=1, headers=SyntheticsTestHeaders( key=\"key_example\", ), host=\"host_example\", method=HTTPMethod(\"GET\"), no_saving_response_body=True, number_of_packets=0, port=1, query={}, should_track_hops=True, timeout=3.14, url=\"url_example\", ), set_cookie=\"set_cookie_example\", variables=[ SyntheticsBrowserVariable( example=\"example_example\", id=\"id_example\", name=\"VARIABLE_NAME\", pattern=\"pattern_example\", type=SyntheticsBrowserVariableType(\"element\"), ), ], ), locations=[ \"locations_example\", ], message=\"\", monitor_id=1, name=\"name_example\", options=SyntheticsTestOptions( accept_self_signed=True, allow_insecure=True, device_ids=[ SyntheticsDeviceID(\"laptop_large\"), ], disable_cors=True, follow_redirects=True, min_failure_duration=1, min_location_failed=1, monitor_options=SyntheticsTestOptionsMonitorOptions( renotify_interval=0, ), no_screenshot=True, retry=SyntheticsTestOptionsRetry( count=1, interval=3.14, ), tick_every=SyntheticsTickInterval(30), ), public_id=\"public_id_example\", status=SyntheticsTestPauseStatus(\"live\"), steps=[ SyntheticsStep( allow_failure=True, name=\"name_example\", params={}, timeout=1, type=SyntheticsStepType(\"assertCurrentUrl\"), ), ], tags=[ \"tags_example\", ], type=SyntheticsBrowserTestType(\"browser\"), ) # SyntheticsBrowserTest | New test details to be saved. # example passing only required values which don't have defaults set try: # Edit a browser test api_response = api_instance.update_browser_test(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_browser_test: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_21","text":"Name Type Description Notes public_id str The public ID of the test to get details from. body SyntheticsBrowserTest New test details to be saved.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_21","text":"SyntheticsBrowserTest","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_21","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_21","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_21","text":"Status code Description Response headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_private_location","text":"SyntheticsPrivateLocation update_private_location(location_id, body) Edit a private location Edit a Synthetics private location.","title":"update_private_location"},{"location":"v1/SyntheticsApi/#example_22","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) location_id = \"location_id_example\" # str | The ID of the private location. body = SyntheticsPrivateLocation( description=\"Description of private location\", id=\"id_example\", name=\"New private location\", secrets=SyntheticsPrivateLocationSecrets( authentication=SyntheticsPrivateLocationSecretsAuthentication( id=\"id_example\", key=\"key_example\", ), config_decryption=SyntheticsPrivateLocationSecretsConfigDecryption( key=\"key_example\", ), ), tags=[\"team:front\"], ) # SyntheticsPrivateLocation | Details of the private location to be updated. # example passing only required values which don't have defaults set try: # Edit a private location api_response = api_instance.update_private_location(location_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_private_location: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_22","text":"Name Type Description Notes location_id str The ID of the private location. body SyntheticsPrivateLocation Details of the private location to be updated.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_22","text":"SyntheticsPrivateLocation","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_22","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_22","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_22","text":"Status code Description Response headers 200 OK - 404 - Private locations are not activated for the user - Private location does not exist - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsApi/#update_test_pause_status","text":"bool update_test_pause_status(public_id, body) Pause or start a test Pause or start a Synthetics test by changing the status.","title":"update_test_pause_status"},{"location":"v1/SyntheticsApi/#example_23","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import synthetics_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = synthetics_api.SyntheticsApi(api_client) public_id = \"public_id_example\" # str | The public ID of the Synthetic test to update. body = SyntheticsUpdateTestPauseStatusPayload( new_status=SyntheticsTestPauseStatus(\"live\"), ) # SyntheticsUpdateTestPauseStatusPayload | Status to set the given Synthetic test to. # example passing only required values which don't have defaults set try: # Pause or start a test api_response = api_instance.update_test_pause_status(public_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SyntheticsApi->update_test_pause_status: %s\\n\" % e)","title":"Example"},{"location":"v1/SyntheticsApi/#parameters_23","text":"Name Type Description Notes public_id str The public ID of the Synthetic test to update. body SyntheticsUpdateTestPauseStatusPayload Status to set the given Synthetic test to.","title":"Parameters"},{"location":"v1/SyntheticsApi/#return-type_23","text":"bool","title":"Return type"},{"location":"v1/SyntheticsApi/#authorization_23","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/SyntheticsApi/#http-request-headers_23","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/SyntheticsApi/#http-response-details_23","text":"Status code Description Response headers 200 OK - Returns a boolean indicating if the update was successful. - 400 JSON format is wrong. - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/SyntheticsAssertion/","text":"SyntheticsAssertion Object describing the assertions type, their associated operator, which property they apply, and upon which target. Properties Name Type Description Notes _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] operator SyntheticsAssertionJSONPathOperator [optional] type SyntheticsAssertionType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertion"},{"location":"v1/SyntheticsAssertion/#syntheticsassertion","text":"Object describing the assertions type, their associated operator, which property they apply, and upon which target.","title":"SyntheticsAssertion"},{"location":"v1/SyntheticsAssertion/#properties","text":"Name Type Description Notes _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] operator SyntheticsAssertionJSONPathOperator [optional] type SyntheticsAssertionType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionJSONPathOperator/","text":"SyntheticsAssertionJSONPathOperator Assertion operator to apply. Properties Name Type Description Notes value str Assertion operator to apply. defaults to \"validatesJSONPath\", must be one of [\"validatesJSONPath\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionJSONPathOperator"},{"location":"v1/SyntheticsAssertionJSONPathOperator/#syntheticsassertionjsonpathoperator","text":"Assertion operator to apply.","title":"SyntheticsAssertionJSONPathOperator"},{"location":"v1/SyntheticsAssertionJSONPathOperator/#properties","text":"Name Type Description Notes value str Assertion operator to apply. defaults to \"validatesJSONPath\", must be one of [\"validatesJSONPath\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionJSONPathTarget/","text":"SyntheticsAssertionJSONPathTarget An assertion for the validatesJSONPath operator. Properties Name Type Description Notes operator SyntheticsAssertionJSONPathOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionJSONPathTarget"},{"location":"v1/SyntheticsAssertionJSONPathTarget/#syntheticsassertionjsonpathtarget","text":"An assertion for the validatesJSONPath operator.","title":"SyntheticsAssertionJSONPathTarget"},{"location":"v1/SyntheticsAssertionJSONPathTarget/#properties","text":"Name Type Description Notes operator SyntheticsAssertionJSONPathOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target SyntheticsAssertionJSONPathTargetTarget [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionJSONPathTargetTarget/","text":"SyntheticsAssertionJSONPathTargetTarget Composed target for validatesJSONPath operator. Properties Name Type Description Notes json_path str The JSON path to assert. [optional] operator str The specific operator to use on the path. [optional] target_value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The path target value to compare to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionJSONPathTargetTarget"},{"location":"v1/SyntheticsAssertionJSONPathTargetTarget/#syntheticsassertionjsonpathtargettarget","text":"Composed target for validatesJSONPath operator.","title":"SyntheticsAssertionJSONPathTargetTarget"},{"location":"v1/SyntheticsAssertionJSONPathTargetTarget/#properties","text":"Name Type Description Notes json_path str The JSON path to assert. [optional] operator str The specific operator to use on the path. [optional] target_value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The path target value to compare to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionOperator/","text":"SyntheticsAssertionOperator Assertion operator to apply. Properties Name Type Description Notes value str Assertion operator to apply. must be one of [\"contains\", \"doesNotContain\", \"is\", \"isNot\", \"lessThan\", \"lessThanOrEqual\", \"moreThan\", \"moreThanOrEqual\", \"matches\", \"doesNotMatch\", \"validates\", \"isInMoreThan\", \"isInLessThan\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionOperator"},{"location":"v1/SyntheticsAssertionOperator/#syntheticsassertionoperator","text":"Assertion operator to apply.","title":"SyntheticsAssertionOperator"},{"location":"v1/SyntheticsAssertionOperator/#properties","text":"Name Type Description Notes value str Assertion operator to apply. must be one of [\"contains\", \"doesNotContain\", \"is\", \"isNot\", \"lessThan\", \"lessThanOrEqual\", \"moreThan\", \"moreThanOrEqual\", \"matches\", \"doesNotMatch\", \"validates\", \"isInMoreThan\", \"isInLessThan\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionTarget/","text":"SyntheticsAssertionTarget An assertion which uses a simple target. Properties Name Type Description Notes operator SyntheticsAssertionOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target bool, date, datetime, dict, float, int, list, str Value used by the operator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionTarget"},{"location":"v1/SyntheticsAssertionTarget/#syntheticsassertiontarget","text":"An assertion which uses a simple target.","title":"SyntheticsAssertionTarget"},{"location":"v1/SyntheticsAssertionTarget/#properties","text":"Name Type Description Notes operator SyntheticsAssertionOperator type SyntheticsAssertionType _property str The associated assertion property. [optional] target bool, date, datetime, dict, float, int, list, str Value used by the operator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsAssertionType/","text":"SyntheticsAssertionType Type of the assertion. Properties Name Type Description Notes value str Type of the assertion. must be one of [\"body\", \"header\", \"statusCode\", \"certificate\", \"responseTime\", \"property\", \"recordEvery\", \"recordSome\", \"tlsVersion\", \"minTlsVersion\", \"latency\", \"packetLossPercentage\", \"packetsReceived\", \"networkHop\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsAssertionType"},{"location":"v1/SyntheticsAssertionType/#syntheticsassertiontype","text":"Type of the assertion.","title":"SyntheticsAssertionType"},{"location":"v1/SyntheticsAssertionType/#properties","text":"Name Type Description Notes value str Type of the assertion. must be one of [\"body\", \"header\", \"statusCode\", \"certificate\", \"responseTime\", \"property\", \"recordEvery\", \"recordSome\", \"tlsVersion\", \"minTlsVersion\", \"latency\", \"packetLossPercentage\", \"packetsReceived\", \"networkHop\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBasicAuth/","text":"SyntheticsBasicAuth Object to handle basic authentication when performing the test. Properties Name Type Description Notes password str Password to use for the basic authentication. username str Username to use for the basic authentication. [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBasicAuth"},{"location":"v1/SyntheticsBasicAuth/#syntheticsbasicauth","text":"Object to handle basic authentication when performing the test.","title":"SyntheticsBasicAuth"},{"location":"v1/SyntheticsBasicAuth/#properties","text":"Name Type Description Notes password str Password to use for the basic authentication. username str Username to use for the basic authentication. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserError/","text":"SyntheticsBrowserError Error response object for a browser test. Properties Name Type Description Notes description str Description of the error. name str Name of the error. type SyntheticsBrowserErrorType status_code int Status Code of the error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserError"},{"location":"v1/SyntheticsBrowserError/#syntheticsbrowsererror","text":"Error response object for a browser test.","title":"SyntheticsBrowserError"},{"location":"v1/SyntheticsBrowserError/#properties","text":"Name Type Description Notes description str Description of the error. name str Name of the error. type SyntheticsBrowserErrorType status_code int Status Code of the error. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserErrorType/","text":"SyntheticsBrowserErrorType Error type returned by a browser test. Properties Name Type Description Notes value str Error type returned by a browser test. must be one of [\"network\", \"js\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserErrorType"},{"location":"v1/SyntheticsBrowserErrorType/#syntheticsbrowsererrortype","text":"Error type returned by a browser test.","title":"SyntheticsBrowserErrorType"},{"location":"v1/SyntheticsBrowserErrorType/#properties","text":"Name Type Description Notes value str Error type returned by a browser test. must be one of [\"network\", \"js\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTest/","text":"SyntheticsBrowserTest Object containing details about a Synthetic browser test. Properties Name Type Description Notes message str Notification message associated with the test. Message can either be text or an empty string. config SyntheticsBrowserTestConfig [optional] locations [str] Array of locations used to run the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID of the test. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] The steps of the test. [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsBrowserTestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTest"},{"location":"v1/SyntheticsBrowserTest/#syntheticsbrowsertest","text":"Object containing details about a Synthetic browser test.","title":"SyntheticsBrowserTest"},{"location":"v1/SyntheticsBrowserTest/#properties","text":"Name Type Description Notes message str Notification message associated with the test. Message can either be text or an empty string. config SyntheticsBrowserTestConfig [optional] locations [str] Array of locations used to run the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The public ID of the test. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] The steps of the test. [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsBrowserTestType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestConfig/","text":"SyntheticsBrowserTestConfig Configuration object for a Synthetic browser test. Properties Name Type Description Notes request SyntheticsTestRequest assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] set_cookie str Cookies to be used for the request, using the Set-Cookie syntax. [optional] variables [SyntheticsBrowserVariable] Array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestConfig"},{"location":"v1/SyntheticsBrowserTestConfig/#syntheticsbrowsertestconfig","text":"Configuration object for a Synthetic browser test.","title":"SyntheticsBrowserTestConfig"},{"location":"v1/SyntheticsBrowserTestConfig/#properties","text":"Name Type Description Notes request SyntheticsTestRequest assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] set_cookie str Cookies to be used for the request, using the Set-Cookie syntax. [optional] variables [SyntheticsBrowserVariable] Array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultData/","text":"SyntheticsBrowserTestResultData Object containing results for your Synthetic browser test. Properties Name Type Description Notes browser_type str Type of browser device used for the browser test. [optional] browser_version str Browser version used for the browser test. [optional] device SyntheticsDevice [optional] duration float Global duration in second of the browser test. [optional] error str Error returned for the browser test. [optional] passed bool Whether or not the browser test was conducted. [optional] received_email_count int The amount of email received during the browser test. [optional] start_url str Starting URL for the browser test. [optional] step_details [SyntheticsStepDetail] Array containing the different browser test steps. [optional] thumbnails_bucket_key bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultData"},{"location":"v1/SyntheticsBrowserTestResultData/#syntheticsbrowsertestresultdata","text":"Object containing results for your Synthetic browser test.","title":"SyntheticsBrowserTestResultData"},{"location":"v1/SyntheticsBrowserTestResultData/#properties","text":"Name Type Description Notes browser_type str Type of browser device used for the browser test. [optional] browser_version str Browser version used for the browser test. [optional] device SyntheticsDevice [optional] duration float Global duration in second of the browser test. [optional] error str Error returned for the browser test. [optional] passed bool Whether or not the browser test was conducted. [optional] received_email_count int The amount of email received during the browser test. [optional] start_url str Starting URL for the browser test. [optional] step_details [SyntheticsStepDetail] Array containing the different browser test steps. [optional] thumbnails_bucket_key bool 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultFull/","text":"SyntheticsBrowserTestResultFull Object returned describing a browser test result. Properties Name Type Description Notes check SyntheticsBrowserTestResultFullCheck [optional] check_time float When the browser test was conducted. [optional] check_version int Version of the browser test used. [optional] probe_dc str Location from which the browser test was performed. [optional] result SyntheticsBrowserTestResultData [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultFull"},{"location":"v1/SyntheticsBrowserTestResultFull/#syntheticsbrowsertestresultfull","text":"Object returned describing a browser test result.","title":"SyntheticsBrowserTestResultFull"},{"location":"v1/SyntheticsBrowserTestResultFull/#properties","text":"Name Type Description Notes check SyntheticsBrowserTestResultFullCheck [optional] check_time float When the browser test was conducted. [optional] check_version int Version of the browser test used. [optional] probe_dc str Location from which the browser test was performed. [optional] result SyntheticsBrowserTestResultData [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultFullCheck/","text":"SyntheticsBrowserTestResultFullCheck Object describing the browser test configuration. Properties Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultFullCheck"},{"location":"v1/SyntheticsBrowserTestResultFullCheck/#syntheticsbrowsertestresultfullcheck","text":"Object describing the browser test configuration.","title":"SyntheticsBrowserTestResultFullCheck"},{"location":"v1/SyntheticsBrowserTestResultFullCheck/#properties","text":"Name Type Description Notes config SyntheticsTestConfig [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultShort/","text":"SyntheticsBrowserTestResultShort Object with the results of a single Synthetic browser test. Properties Name Type Description Notes check_time float Last time the browser test was performed. [optional] probe_dc str Location from which the Browser test was performed. [optional] result SyntheticsBrowserTestResultShortResult [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultShort"},{"location":"v1/SyntheticsBrowserTestResultShort/#syntheticsbrowsertestresultshort","text":"Object with the results of a single Synthetic browser test.","title":"SyntheticsBrowserTestResultShort"},{"location":"v1/SyntheticsBrowserTestResultShort/#properties","text":"Name Type Description Notes check_time float Last time the browser test was performed. [optional] probe_dc str Location from which the Browser test was performed. [optional] result SyntheticsBrowserTestResultShortResult [optional] result_id str ID of the browser test result. [optional] status SyntheticsTestMonitorStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestResultShortResult/","text":"SyntheticsBrowserTestResultShortResult Object with the result of the last browser test run. Properties Name Type Description Notes device SyntheticsDevice [optional] duration float Length in second of the browser test run. [optional] error_count int Amount of errors collected for a single browser test run. [optional] step_count_completed int Amount of browser test steps completed before failing. [optional] step_count_total int Total amount of browser test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestResultShortResult"},{"location":"v1/SyntheticsBrowserTestResultShortResult/#syntheticsbrowsertestresultshortresult","text":"Object with the result of the last browser test run.","title":"SyntheticsBrowserTestResultShortResult"},{"location":"v1/SyntheticsBrowserTestResultShortResult/#properties","text":"Name Type Description Notes device SyntheticsDevice [optional] duration float Length in second of the browser test run. [optional] error_count int Amount of errors collected for a single browser test run. [optional] step_count_completed int Amount of browser test steps completed before failing. [optional] step_count_total int Total amount of browser test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserTestType/","text":"SyntheticsBrowserTestType Type of the Synthetic test, browser . Properties Name Type Description Notes value str Type of the Synthetic test, `browser`. defaults to \"browser\", must be one of [\"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserTestType"},{"location":"v1/SyntheticsBrowserTestType/#syntheticsbrowsertesttype","text":"Type of the Synthetic test, browser .","title":"SyntheticsBrowserTestType"},{"location":"v1/SyntheticsBrowserTestType/#properties","text":"Name Type Description Notes value str Type of the Synthetic test, `browser`. defaults to \"browser\", must be one of [\"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserVariable/","text":"SyntheticsBrowserVariable Object defining a variable that can be used in your browser test. Learn more in the Browser test Actions documentation . Properties Name Type Description Notes name str Name of the variable. type SyntheticsBrowserVariableType example str Example for the variable. [optional] id str ID for the variable. [optional] pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserVariable"},{"location":"v1/SyntheticsBrowserVariable/#syntheticsbrowservariable","text":"Object defining a variable that can be used in your browser test. Learn more in the Browser test Actions documentation .","title":"SyntheticsBrowserVariable"},{"location":"v1/SyntheticsBrowserVariable/#properties","text":"Name Type Description Notes name str Name of the variable. type SyntheticsBrowserVariableType example str Example for the variable. [optional] id str ID for the variable. [optional] pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsBrowserVariableType/","text":"SyntheticsBrowserVariableType Type of browser test variable. Properties Name Type Description Notes value str Type of browser test variable. must be one of [\"element\", \"email\", \"global\", \"javascript\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsBrowserVariableType"},{"location":"v1/SyntheticsBrowserVariableType/#syntheticsbrowservariabletype","text":"Type of browser test variable.","title":"SyntheticsBrowserVariableType"},{"location":"v1/SyntheticsBrowserVariableType/#properties","text":"Name Type Description Notes value str Type of browser test variable. must be one of [\"element\", \"email\", \"global\", \"javascript\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITest/","text":"SyntheticsCITest Test configuration for Synthetics CI Properties Name Type Description Notes public_id str The public ID of the Synthetics test to trigger. allow_insecure_certificates bool Disable certificate checks in API tests. [optional] basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] body_type str Type of the data sent in a synthetics API test. [optional] cookies str Cookies for the request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] headers SyntheticsTestHeaders [optional] locations [str] Array of locations used to run the test. [optional] metadata SyntheticsCITestMetadata [optional] retry SyntheticsTestOptionsRetry [optional] start_url str Starting URL for the browser test. [optional] variables {str: (str,)} Variables to replace in the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITest"},{"location":"v1/SyntheticsCITest/#syntheticscitest","text":"Test configuration for Synthetics CI","title":"SyntheticsCITest"},{"location":"v1/SyntheticsCITest/#properties","text":"Name Type Description Notes public_id str The public ID of the Synthetics test to trigger. allow_insecure_certificates bool Disable certificate checks in API tests. [optional] basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] body_type str Type of the data sent in a synthetics API test. [optional] cookies str Cookies for the request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] headers SyntheticsTestHeaders [optional] locations [str] Array of locations used to run the test. [optional] metadata SyntheticsCITestMetadata [optional] retry SyntheticsTestOptionsRetry [optional] start_url str Starting URL for the browser test. [optional] variables {str: (str,)} Variables to replace in the test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestBody/","text":"SyntheticsCITestBody Object describing the synthetics tests to trigger. Properties Name Type Description Notes tests [SyntheticsCITest] Individual synthetics test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestBody"},{"location":"v1/SyntheticsCITestBody/#syntheticscitestbody","text":"Object describing the synthetics tests to trigger.","title":"SyntheticsCITestBody"},{"location":"v1/SyntheticsCITestBody/#properties","text":"Name Type Description Notes tests [SyntheticsCITest] Individual synthetics test. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestMetadata/","text":"SyntheticsCITestMetadata Metadata for the Synthetics tests run Properties Name Type Description Notes ci SyntheticsCITestMetadataCi [optional] git SyntheticsCITestMetadataGit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestMetadata"},{"location":"v1/SyntheticsCITestMetadata/#syntheticscitestmetadata","text":"Metadata for the Synthetics tests run","title":"SyntheticsCITestMetadata"},{"location":"v1/SyntheticsCITestMetadata/#properties","text":"Name Type Description Notes ci SyntheticsCITestMetadataCi [optional] git SyntheticsCITestMetadataGit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestMetadataCi/","text":"SyntheticsCITestMetadataCi Describe CI provider. Properties Name Type Description Notes pipeline str Name of the pipeline. [optional] provider str Name of the CI provider. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestMetadataCi"},{"location":"v1/SyntheticsCITestMetadataCi/#syntheticscitestmetadataci","text":"Describe CI provider.","title":"SyntheticsCITestMetadataCi"},{"location":"v1/SyntheticsCITestMetadataCi/#properties","text":"Name Type Description Notes pipeline str Name of the pipeline. [optional] provider str Name of the CI provider. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCITestMetadataGit/","text":"SyntheticsCITestMetadataGit Git information. Properties Name Type Description Notes branch str Branch name. [optional] commit_sha str Commit SHA. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCITestMetadataGit"},{"location":"v1/SyntheticsCITestMetadataGit/#syntheticscitestmetadatagit","text":"Git information.","title":"SyntheticsCITestMetadataGit"},{"location":"v1/SyntheticsCITestMetadataGit/#properties","text":"Name Type Description Notes branch str Branch name. [optional] commit_sha str Commit SHA. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCheckType/","text":"SyntheticsCheckType Type of assertion to apply in an API test. Properties Name Type Description Notes value str Type of assertion to apply in an API test. must be one of [\"equals\", \"notEquals\", \"contains\", \"notContains\", \"startsWith\", \"notStartsWith\", \"greater\", \"lower\", \"greaterEquals\", \"lowerEquals\", \"matchRegex\", \"between\", \"isEmpty\", \"notIsEmpty\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCheckType"},{"location":"v1/SyntheticsCheckType/#syntheticschecktype","text":"Type of assertion to apply in an API test.","title":"SyntheticsCheckType"},{"location":"v1/SyntheticsCheckType/#properties","text":"Name Type Description Notes value str Type of assertion to apply in an API test. must be one of [\"equals\", \"notEquals\", \"contains\", \"notContains\", \"startsWith\", \"notStartsWith\", \"greater\", \"lower\", \"greaterEquals\", \"lowerEquals\", \"matchRegex\", \"between\", \"isEmpty\", \"notIsEmpty\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsConfigVariable/","text":"SyntheticsConfigVariable Object defining a variable that can be used in your test configuration. Properties Name Type Description Notes example str Example for the variable. name str Name of the variable. type SyntheticsConfigVariableType pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsConfigVariable"},{"location":"v1/SyntheticsConfigVariable/#syntheticsconfigvariable","text":"Object defining a variable that can be used in your test configuration.","title":"SyntheticsConfigVariable"},{"location":"v1/SyntheticsConfigVariable/#properties","text":"Name Type Description Notes example str Example for the variable. name str Name of the variable. type SyntheticsConfigVariableType pattern str Pattern of the variable. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsConfigVariableType/","text":"SyntheticsConfigVariableType Type of the configuration variable. Properties Name Type Description Notes value str Type of the configuration variable. defaults to \"text\", must be one of [\"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsConfigVariableType"},{"location":"v1/SyntheticsConfigVariableType/#syntheticsconfigvariabletype","text":"Type of the configuration variable.","title":"SyntheticsConfigVariableType"},{"location":"v1/SyntheticsConfigVariableType/#properties","text":"Name Type Description Notes value str Type of the configuration variable. defaults to \"text\", must be one of [\"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsCoreWebVitals/","text":"SyntheticsCoreWebVitals Core Web Vitals attached to a browser test step. Properties Name Type Description Notes cls int Cumulative Layout Shift. [optional] lcp int Largest Contentful Paint in milliseconds. [optional] url str URL attached to the metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsCoreWebVitals"},{"location":"v1/SyntheticsCoreWebVitals/#syntheticscorewebvitals","text":"Core Web Vitals attached to a browser test step.","title":"SyntheticsCoreWebVitals"},{"location":"v1/SyntheticsCoreWebVitals/#properties","text":"Name Type Description Notes cls int Cumulative Layout Shift. [optional] lcp int Largest Contentful Paint in milliseconds. [optional] url str URL attached to the metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeleteTestsPayload/","text":"SyntheticsDeleteTestsPayload A JSON list of the ID or IDs of the Synthetic tests that you want to delete. Properties Name Type Description Notes public_ids [str] An array of Synthetic test IDs you want to delete. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeleteTestsPayload"},{"location":"v1/SyntheticsDeleteTestsPayload/#syntheticsdeletetestspayload","text":"A JSON list of the ID or IDs of the Synthetic tests that you want to delete.","title":"SyntheticsDeleteTestsPayload"},{"location":"v1/SyntheticsDeleteTestsPayload/#properties","text":"Name Type Description Notes public_ids [str] An array of Synthetic test IDs you want to delete. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeleteTestsResponse/","text":"SyntheticsDeleteTestsResponse Response object for deleting Synthetic tests. Properties Name Type Description Notes deleted_tests [SyntheticsDeletedTest] Array of objects containing a deleted Synthetic test ID with the associated deletion timestamp. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeleteTestsResponse"},{"location":"v1/SyntheticsDeleteTestsResponse/#syntheticsdeletetestsresponse","text":"Response object for deleting Synthetic tests.","title":"SyntheticsDeleteTestsResponse"},{"location":"v1/SyntheticsDeleteTestsResponse/#properties","text":"Name Type Description Notes deleted_tests [SyntheticsDeletedTest] Array of objects containing a deleted Synthetic test ID with the associated deletion timestamp. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeletedTest/","text":"SyntheticsDeletedTest Object containing a deleted Synthetic test ID with the associated deletion timestamp. Properties Name Type Description Notes deleted_at datetime Deletion timestamp of the Synthetic test ID. [optional] public_id str The Synthetic test ID deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeletedTest"},{"location":"v1/SyntheticsDeletedTest/#syntheticsdeletedtest","text":"Object containing a deleted Synthetic test ID with the associated deletion timestamp.","title":"SyntheticsDeletedTest"},{"location":"v1/SyntheticsDeletedTest/#properties","text":"Name Type Description Notes deleted_at datetime Deletion timestamp of the Synthetic test ID. [optional] public_id str The Synthetic test ID deleted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDevice/","text":"SyntheticsDevice Object describing the device used to perform the Synthetic test. Properties Name Type Description Notes height int Screen height of the device. id SyntheticsDeviceID name str The device name. width int Screen width of the device. is_mobile bool Whether or not the device is a mobile. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDevice"},{"location":"v1/SyntheticsDevice/#syntheticsdevice","text":"Object describing the device used to perform the Synthetic test.","title":"SyntheticsDevice"},{"location":"v1/SyntheticsDevice/#properties","text":"Name Type Description Notes height int Screen height of the device. id SyntheticsDeviceID name str The device name. width int Screen width of the device. is_mobile bool Whether or not the device is a mobile. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsDeviceID/","text":"SyntheticsDeviceID The device ID. Properties Name Type Description Notes value str The device ID. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsDeviceID"},{"location":"v1/SyntheticsDeviceID/#syntheticsdeviceid","text":"The device ID.","title":"SyntheticsDeviceID"},{"location":"v1/SyntheticsDeviceID/#properties","text":"Name Type Description Notes value str The device ID. must be one of [\"laptop_large\", \"tablet\", \"mobile_small\", \"chrome.laptop_large\", \"chrome.tablet\", \"chrome.mobile_small\", \"firefox.laptop_large\", \"firefox.tablet\", \"firefox.mobile_small\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsErrorCode/","text":"SyntheticsErrorCode Error code that can be returned by a Synthetic test. Properties Name Type Description Notes value str Error code that can be returned by a Synthetic test. must be one of [\"NO_ERROR\", \"UNKNOWN\", \"DNS\", \"SSL\", \"TIMEOUT\", \"DENIED\", \"INCORRECT_ASSERTION\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsErrorCode"},{"location":"v1/SyntheticsErrorCode/#syntheticserrorcode","text":"Error code that can be returned by a Synthetic test.","title":"SyntheticsErrorCode"},{"location":"v1/SyntheticsErrorCode/#properties","text":"Name Type Description Notes value str Error code that can be returned by a Synthetic test. must be one of [\"NO_ERROR\", \"UNKNOWN\", \"DNS\", \"SSL\", \"TIMEOUT\", \"DENIED\", \"INCORRECT_ASSERTION\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGetAPITestLatestResultsResponse/","text":"SyntheticsGetAPITestLatestResultsResponse Object with the latest Synthetic API test run. Properties Name Type Description Notes last_timestamp_fetched int Timestamp of the latest API test run. [optional] results [SyntheticsAPITestResultShort] Result of the latest API test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGetAPITestLatestResultsResponse"},{"location":"v1/SyntheticsGetAPITestLatestResultsResponse/#syntheticsgetapitestlatestresultsresponse","text":"Object with the latest Synthetic API test run.","title":"SyntheticsGetAPITestLatestResultsResponse"},{"location":"v1/SyntheticsGetAPITestLatestResultsResponse/#properties","text":"Name Type Description Notes last_timestamp_fetched int Timestamp of the latest API test run. [optional] results [SyntheticsAPITestResultShort] Result of the latest API test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGetBrowserTestLatestResultsResponse/","text":"SyntheticsGetBrowserTestLatestResultsResponse Object with the latest Synthetic browser test run. Properties Name Type Description Notes last_timestamp_fetched int Timestamp of the latest browser test run. [optional] results [SyntheticsBrowserTestResultShort] Result of the latest browser test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGetBrowserTestLatestResultsResponse"},{"location":"v1/SyntheticsGetBrowserTestLatestResultsResponse/#syntheticsgetbrowsertestlatestresultsresponse","text":"Object with the latest Synthetic browser test run.","title":"SyntheticsGetBrowserTestLatestResultsResponse"},{"location":"v1/SyntheticsGetBrowserTestLatestResultsResponse/#properties","text":"Name Type Description Notes last_timestamp_fetched int Timestamp of the latest browser test run. [optional] results [SyntheticsBrowserTestResultShort] Result of the latest browser test run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariable/","text":"SyntheticsGlobalVariable Synthetics global variable. Properties Name Type Description Notes description str Description of the global variable. name str Name of the global variable. tags [str] Tags of the global variable. value SyntheticsGlobalVariableValue id str Unique identifier of the global variable. optional parse_test_options SyntheticsGlobalVariableParseTestOptions [optional] parse_test_public_id str A Synthetic test ID to use as a test to generate the variable value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariable"},{"location":"v1/SyntheticsGlobalVariable/#syntheticsglobalvariable","text":"Synthetics global variable.","title":"SyntheticsGlobalVariable"},{"location":"v1/SyntheticsGlobalVariable/#properties","text":"Name Type Description Notes description str Description of the global variable. name str Name of the global variable. tags [str] Tags of the global variable. value SyntheticsGlobalVariableValue id str Unique identifier of the global variable. optional parse_test_options SyntheticsGlobalVariableParseTestOptions [optional] parse_test_public_id str A Synthetic test ID to use as a test to generate the variable value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableParseTestOptions/","text":"SyntheticsGlobalVariableParseTestOptions Parser options to use for retrieving a Synthetics global variable from a Synthetics Test. Used in conjunction with parse_test_public_id . Properties Name Type Description Notes parser SyntheticsVariableParser type SyntheticsGlobalVariableParseTestOptionsType field str When type is `http_header`, name of the header to use to extract the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableParseTestOptions"},{"location":"v1/SyntheticsGlobalVariableParseTestOptions/#syntheticsglobalvariableparsetestoptions","text":"Parser options to use for retrieving a Synthetics global variable from a Synthetics Test. Used in conjunction with parse_test_public_id .","title":"SyntheticsGlobalVariableParseTestOptions"},{"location":"v1/SyntheticsGlobalVariableParseTestOptions/#properties","text":"Name Type Description Notes parser SyntheticsVariableParser type SyntheticsGlobalVariableParseTestOptionsType field str When type is `http_header`, name of the header to use to extract the value. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableParseTestOptionsType/","text":"SyntheticsGlobalVariableParseTestOptionsType Property of the Synthetics Test Response to use for a Synthetics global variable. Properties Name Type Description Notes value str Property of the Synthetics Test Response to use for a Synthetics global variable. must be one of [\"http_body\", \"http_header\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableParseTestOptionsType"},{"location":"v1/SyntheticsGlobalVariableParseTestOptionsType/#syntheticsglobalvariableparsetestoptionstype","text":"Property of the Synthetics Test Response to use for a Synthetics global variable.","title":"SyntheticsGlobalVariableParseTestOptionsType"},{"location":"v1/SyntheticsGlobalVariableParseTestOptionsType/#properties","text":"Name Type Description Notes value str Property of the Synthetics Test Response to use for a Synthetics global variable. must be one of [\"http_body\", \"http_header\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableParserType/","text":"SyntheticsGlobalVariableParserType Type of parser for a Synthetics global variable from a synthetics test. Properties Name Type Description Notes value str Type of parser for a Synthetics global variable from a synthetics test. must be one of [\"raw\", \"json_path\", \"regex\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableParserType"},{"location":"v1/SyntheticsGlobalVariableParserType/#syntheticsglobalvariableparsertype","text":"Type of parser for a Synthetics global variable from a synthetics test.","title":"SyntheticsGlobalVariableParserType"},{"location":"v1/SyntheticsGlobalVariableParserType/#properties","text":"Name Type Description Notes value str Type of parser for a Synthetics global variable from a synthetics test. must be one of [\"raw\", \"json_path\", \"regex\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsGlobalVariableValue/","text":"SyntheticsGlobalVariableValue Value of the global variable. Properties Name Type Description Notes value str Value of the global variable. When reading a global variable, the value will not be present if the variable is secure. secure bool Determines if the variable is secure. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsGlobalVariableValue"},{"location":"v1/SyntheticsGlobalVariableValue/#syntheticsglobalvariablevalue","text":"Value of the global variable.","title":"SyntheticsGlobalVariableValue"},{"location":"v1/SyntheticsGlobalVariableValue/#properties","text":"Name Type Description Notes value str Value of the global variable. When reading a global variable, the value will not be present if the variable is secure. secure bool Determines if the variable is secure. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsListTestsResponse/","text":"SyntheticsListTestsResponse Object containing an array of Synthetic tests configuration. Properties Name Type Description Notes tests [SyntheticsTestDetails] Array of Synthetic tests configuration. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsListTestsResponse"},{"location":"v1/SyntheticsListTestsResponse/#syntheticslisttestsresponse","text":"Object containing an array of Synthetic tests configuration.","title":"SyntheticsListTestsResponse"},{"location":"v1/SyntheticsListTestsResponse/#properties","text":"Name Type Description Notes tests [SyntheticsTestDetails] Array of Synthetic tests configuration. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsLocation/","text":"SyntheticsLocation Synthetic location that can be used when creating or editing a test. Properties Name Type Description Notes id str Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsLocation"},{"location":"v1/SyntheticsLocation/#syntheticslocation","text":"Synthetic location that can be used when creating or editing a test.","title":"SyntheticsLocation"},{"location":"v1/SyntheticsLocation/#properties","text":"Name Type Description Notes id str Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsLocations/","text":"SyntheticsLocations List of Synthetics locations. Properties Name Type Description Notes locations [SyntheticsLocation] List of Synthetics locations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsLocations"},{"location":"v1/SyntheticsLocations/#syntheticslocations","text":"List of Synthetics locations.","title":"SyntheticsLocations"},{"location":"v1/SyntheticsLocations/#properties","text":"Name Type Description Notes locations [SyntheticsLocation] List of Synthetics locations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsParsingOptions/","text":"SyntheticsParsingOptions Parsing options for variables to extract. Properties Name Type Description Notes field str When type is `http_header`, name of the header to use to extract the value. [optional] name str Name of the variable to extract. [optional] parser SyntheticsVariableParser [optional] type SyntheticsGlobalVariableParseTestOptionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsParsingOptions"},{"location":"v1/SyntheticsParsingOptions/#syntheticsparsingoptions","text":"Parsing options for variables to extract.","title":"SyntheticsParsingOptions"},{"location":"v1/SyntheticsParsingOptions/#properties","text":"Name Type Description Notes field str When type is `http_header`, name of the header to use to extract the value. [optional] name str Name of the variable to extract. [optional] parser SyntheticsVariableParser [optional] type SyntheticsGlobalVariableParseTestOptionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPlayingTab/","text":"SyntheticsPlayingTab Navigate between different tabs for your browser test. Properties Name Type Description Notes value int Navigate between different tabs for your browser test. must be one of [-1, 0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPlayingTab"},{"location":"v1/SyntheticsPlayingTab/#syntheticsplayingtab","text":"Navigate between different tabs for your browser test.","title":"SyntheticsPlayingTab"},{"location":"v1/SyntheticsPlayingTab/#properties","text":"Name Type Description Notes value int Navigate between different tabs for your browser test. must be one of [-1, 0, 1, 2, 3, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocation/","text":"SyntheticsPrivateLocation Object containing information about the private location to create. Properties Name Type Description Notes description str Description of the private location. name str Name of the private location. tags [str] Array of tags attached to the private location. id str Unique identifier of the private location. optional secrets SyntheticsPrivateLocationSecrets [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocation"},{"location":"v1/SyntheticsPrivateLocation/#syntheticsprivatelocation","text":"Object containing information about the private location to create.","title":"SyntheticsPrivateLocation"},{"location":"v1/SyntheticsPrivateLocation/#properties","text":"Name Type Description Notes description str Description of the private location. name str Name of the private location. tags [str] Array of tags attached to the private location. id str Unique identifier of the private location. optional secrets SyntheticsPrivateLocationSecrets [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationCreationResponse/","text":"SyntheticsPrivateLocationCreationResponse Object that contains the new private location, the public key for result encryption, and the configuration skeleton. Properties Name Type Description Notes config {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. [optional] private_location SyntheticsPrivateLocation [optional] result_encryption SyntheticsPrivateLocationCreationResponseResultEncryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationCreationResponse"},{"location":"v1/SyntheticsPrivateLocationCreationResponse/#syntheticsprivatelocationcreationresponse","text":"Object that contains the new private location, the public key for result encryption, and the configuration skeleton.","title":"SyntheticsPrivateLocationCreationResponse"},{"location":"v1/SyntheticsPrivateLocationCreationResponse/#properties","text":"Name Type Description Notes config {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. [optional] private_location SyntheticsPrivateLocation [optional] result_encryption SyntheticsPrivateLocationCreationResponseResultEncryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationCreationResponseResultEncryption/","text":"SyntheticsPrivateLocationCreationResponseResultEncryption Public key for the result encryption. Properties Name Type Description Notes id str Fingerprint for the encryption key. [optional] key str Public key for result encryption. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationCreationResponseResultEncryption"},{"location":"v1/SyntheticsPrivateLocationCreationResponseResultEncryption/#syntheticsprivatelocationcreationresponseresultencryption","text":"Public key for the result encryption.","title":"SyntheticsPrivateLocationCreationResponseResultEncryption"},{"location":"v1/SyntheticsPrivateLocationCreationResponseResultEncryption/#properties","text":"Name Type Description Notes id str Fingerprint for the encryption key. [optional] key str Public key for result encryption. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationSecrets/","text":"SyntheticsPrivateLocationSecrets Secrets for the private location. Only present in the response when creating the private location. Properties Name Type Description Notes authentication SyntheticsPrivateLocationSecretsAuthentication [optional] config_decryption SyntheticsPrivateLocationSecretsConfigDecryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationSecrets"},{"location":"v1/SyntheticsPrivateLocationSecrets/#syntheticsprivatelocationsecrets","text":"Secrets for the private location. Only present in the response when creating the private location.","title":"SyntheticsPrivateLocationSecrets"},{"location":"v1/SyntheticsPrivateLocationSecrets/#properties","text":"Name Type Description Notes authentication SyntheticsPrivateLocationSecretsAuthentication [optional] config_decryption SyntheticsPrivateLocationSecretsConfigDecryption [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationSecretsAuthentication/","text":"SyntheticsPrivateLocationSecretsAuthentication Authentication part of the secrets. Properties Name Type Description Notes id str Access key for the private location. optional key str Secret access key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationSecretsAuthentication"},{"location":"v1/SyntheticsPrivateLocationSecretsAuthentication/#syntheticsprivatelocationsecretsauthentication","text":"Authentication part of the secrets.","title":"SyntheticsPrivateLocationSecretsAuthentication"},{"location":"v1/SyntheticsPrivateLocationSecretsAuthentication/#properties","text":"Name Type Description Notes id str Access key for the private location. optional key str Secret access key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsPrivateLocationSecretsConfigDecryption/","text":"SyntheticsPrivateLocationSecretsConfigDecryption Private key for the private location. Properties Name Type Description Notes key str Private key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsPrivateLocationSecretsConfigDecryption"},{"location":"v1/SyntheticsPrivateLocationSecretsConfigDecryption/#syntheticsprivatelocationsecretsconfigdecryption","text":"Private key for the private location.","title":"SyntheticsPrivateLocationSecretsConfigDecryption"},{"location":"v1/SyntheticsPrivateLocationSecretsConfigDecryption/#properties","text":"Name Type Description Notes key str Private key for the private location. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsSSLCertificate/","text":"SyntheticsSSLCertificate Object describing the SSL certificate used for a Synthetic test. Properties Name Type Description Notes cipher str Cipher used for the connection. [optional] exponent float Exponent associated to the certificate. [optional] ext_key_usage [str] Array of extensions and details used for the certificate. [optional] fingerprint str MD5 digest of the DER-encoded Certificate information. [optional] fingerprint256 str SHA-1 digest of the DER-encoded Certificate information. [optional] issuer SyntheticsSSLCertificateIssuer [optional] modulus str Modulus associated to the SSL certificate private key. [optional] protocol str TLS protocol used for the test. [optional] serial_number str Serial Number assigned by Symantec to the SSL certificate. [optional] subject SyntheticsSSLCertificateSubject [optional] valid_from datetime Date from which the SSL certificate is valid. [optional] valid_to datetime Date until which the SSL certificate is valid. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsSSLCertificate"},{"location":"v1/SyntheticsSSLCertificate/#syntheticssslcertificate","text":"Object describing the SSL certificate used for a Synthetic test.","title":"SyntheticsSSLCertificate"},{"location":"v1/SyntheticsSSLCertificate/#properties","text":"Name Type Description Notes cipher str Cipher used for the connection. [optional] exponent float Exponent associated to the certificate. [optional] ext_key_usage [str] Array of extensions and details used for the certificate. [optional] fingerprint str MD5 digest of the DER-encoded Certificate information. [optional] fingerprint256 str SHA-1 digest of the DER-encoded Certificate information. [optional] issuer SyntheticsSSLCertificateIssuer [optional] modulus str Modulus associated to the SSL certificate private key. [optional] protocol str TLS protocol used for the test. [optional] serial_number str Serial Number assigned by Symantec to the SSL certificate. [optional] subject SyntheticsSSLCertificateSubject [optional] valid_from datetime Date from which the SSL certificate is valid. [optional] valid_to datetime Date until which the SSL certificate is valid. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsSSLCertificateIssuer/","text":"SyntheticsSSLCertificateIssuer Object describing the issuer of a SSL certificate. Properties Name Type Description Notes c str Country Name that issued the certificate. [optional] cn str Common Name that issued certificate. [optional] l str Locality that issued the certificate. [optional] o str Organization that issued the certificate. [optional] ou str Organizational Unit that issued the certificate. [optional] st str State Or Province Name that issued the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsSSLCertificateIssuer"},{"location":"v1/SyntheticsSSLCertificateIssuer/#syntheticssslcertificateissuer","text":"Object describing the issuer of a SSL certificate.","title":"SyntheticsSSLCertificateIssuer"},{"location":"v1/SyntheticsSSLCertificateIssuer/#properties","text":"Name Type Description Notes c str Country Name that issued the certificate. [optional] cn str Common Name that issued certificate. [optional] l str Locality that issued the certificate. [optional] o str Organization that issued the certificate. [optional] ou str Organizational Unit that issued the certificate. [optional] st str State Or Province Name that issued the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsSSLCertificateSubject/","text":"SyntheticsSSLCertificateSubject Object describing the SSL certificate used for the test. Properties Name Type Description Notes c str Country Name associated with the certificate. [optional] cn str Common Name that associated with the certificate. [optional] l str Locality associated with the certificate. [optional] o str Organization associated with the certificate. [optional] ou str Organizational Unit associated with the certificate. [optional] st str State Or Province Name associated with the certificate. [optional] alt_name str Subject Alternative Name associated with the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsSSLCertificateSubject"},{"location":"v1/SyntheticsSSLCertificateSubject/#syntheticssslcertificatesubject","text":"Object describing the SSL certificate used for the test.","title":"SyntheticsSSLCertificateSubject"},{"location":"v1/SyntheticsSSLCertificateSubject/#properties","text":"Name Type Description Notes c str Country Name associated with the certificate. [optional] cn str Common Name that associated with the certificate. [optional] l str Locality associated with the certificate. [optional] o str Organization associated with the certificate. [optional] ou str Organizational Unit associated with the certificate. [optional] st str State Or Province Name associated with the certificate. [optional] alt_name str Subject Alternative Name associated with the certificate. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStep/","text":"SyntheticsStep The steps used in a Synthetics browser test. Properties Name Type Description Notes allow_failure bool A boolean set to allow this step to fail. [optional] name str The name of the step. [optional] params {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The parameters of the step. [optional] timeout int The time before declaring a step failed. [optional] type SyntheticsStepType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStep"},{"location":"v1/SyntheticsStep/#syntheticsstep","text":"The steps used in a Synthetics browser test.","title":"SyntheticsStep"},{"location":"v1/SyntheticsStep/#properties","text":"Name Type Description Notes allow_failure bool A boolean set to allow this step to fail. [optional] name str The name of the step. [optional] params {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The parameters of the step. [optional] timeout int The time before declaring a step failed. [optional] type SyntheticsStepType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStepDetail/","text":"SyntheticsStepDetail Object describing a step for a Synthetic test. Properties Name Type Description Notes browser_errors [SyntheticsBrowserError] Array of errors collected for a browser test. [optional] check_type SyntheticsCheckType [optional] description str Description of the test. [optional] duration float Total duration in millisecond of the test. [optional] error str Error returned by the test. [optional] playing_tab SyntheticsPlayingTab [optional] screenshot_bucket_key bool Whether or not screenshots where collected by the test. [optional] skipped bool Whether or not to skip this step. [optional] snapshot_bucket_key bool Whether or not snapshots where collected by the test. [optional] step_id int The step ID. [optional] sub_test_step_details [SyntheticsStepDetail] If this steps include a sub-test. Subtests documentation . [optional] time_to_interactive float Time before starting the step. [optional] type SyntheticsStepType [optional] url str URL to perform the step against. [optional] value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Value for the step. [optional] vitals_metrics [SyntheticsCoreWebVitals] Array of Core Web Vitals metrics for the step. [optional] warnings [SyntheticsStepDetailWarning] Warning collected that didn't failed the step. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStepDetail"},{"location":"v1/SyntheticsStepDetail/#syntheticsstepdetail","text":"Object describing a step for a Synthetic test.","title":"SyntheticsStepDetail"},{"location":"v1/SyntheticsStepDetail/#properties","text":"Name Type Description Notes browser_errors [SyntheticsBrowserError] Array of errors collected for a browser test. [optional] check_type SyntheticsCheckType [optional] description str Description of the test. [optional] duration float Total duration in millisecond of the test. [optional] error str Error returned by the test. [optional] playing_tab SyntheticsPlayingTab [optional] screenshot_bucket_key bool Whether or not screenshots where collected by the test. [optional] skipped bool Whether or not to skip this step. [optional] snapshot_bucket_key bool Whether or not snapshots where collected by the test. [optional] step_id int The step ID. [optional] sub_test_step_details [SyntheticsStepDetail] If this steps include a sub-test. Subtests documentation . [optional] time_to_interactive float Time before starting the step. [optional] type SyntheticsStepType [optional] url str URL to perform the step against. [optional] value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Value for the step. [optional] vitals_metrics [SyntheticsCoreWebVitals] Array of Core Web Vitals metrics for the step. [optional] warnings [SyntheticsStepDetailWarning] Warning collected that didn't failed the step. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStepDetailWarning/","text":"SyntheticsStepDetailWarning Object collecting warnings for a given step. Properties Name Type Description Notes message str Message for the warning. type SyntheticsWarningType [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStepDetailWarning"},{"location":"v1/SyntheticsStepDetailWarning/#syntheticsstepdetailwarning","text":"Object collecting warnings for a given step.","title":"SyntheticsStepDetailWarning"},{"location":"v1/SyntheticsStepDetailWarning/#properties","text":"Name Type Description Notes message str Message for the warning. type SyntheticsWarningType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsStepType/","text":"SyntheticsStepType Step type used in your Synthetic test. Properties Name Type Description Notes value str Step type used in your Synthetic test. must be one of [\"assertCurrentUrl\", \"assertElementAttribute\", \"assertElementContent\", \"assertElementPresent\", \"assertEmail\", \"assertFileDownload\", \"assertFromJavascript\", \"assertPageContains\", \"assertPageLacks\", \"click\", \"extractFromJavascript\", \"extractVariable\", \"goToEmailLink\", \"goToUrl\", \"goToUrlAndMeasureTti\", \"hover\", \"playSubTest\", \"pressKey\", \"refresh\", \"runApiTest\", \"scroll\", \"selectOption\", \"typeText\", \"uploadFiles\", \"wait\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsStepType"},{"location":"v1/SyntheticsStepType/#syntheticssteptype","text":"Step type used in your Synthetic test.","title":"SyntheticsStepType"},{"location":"v1/SyntheticsStepType/#properties","text":"Name Type Description Notes value str Step type used in your Synthetic test. must be one of [\"assertCurrentUrl\", \"assertElementAttribute\", \"assertElementContent\", \"assertElementPresent\", \"assertEmail\", \"assertFileDownload\", \"assertFromJavascript\", \"assertPageContains\", \"assertPageLacks\", \"click\", \"extractFromJavascript\", \"extractVariable\", \"goToEmailLink\", \"goToUrl\", \"goToUrlAndMeasureTti\", \"hover\", \"playSubTest\", \"pressKey\", \"refresh\", \"runApiTest\", \"scroll\", \"selectOption\", \"typeText\", \"uploadFiles\", \"wait\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestConfig/","text":"SyntheticsTestConfig Configuration object for a Synthetic test. Properties Name Type Description Notes assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional] request SyntheticsTestRequest [optional] variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestConfig"},{"location":"v1/SyntheticsTestConfig/#syntheticstestconfig","text":"Configuration object for a Synthetic test.","title":"SyntheticsTestConfig"},{"location":"v1/SyntheticsTestConfig/#properties","text":"Name Type Description Notes assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to [] config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional] request SyntheticsTestRequest [optional] variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestDetails/","text":"SyntheticsTestDetails Object containing details about your Synthetic test. Properties Name Type Description Notes config SyntheticsTestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The test public ID. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] For browser test, the steps of the test. [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsTestDetailsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestDetails"},{"location":"v1/SyntheticsTestDetails/#syntheticstestdetails","text":"Object containing details about your Synthetic test.","title":"SyntheticsTestDetails"},{"location":"v1/SyntheticsTestDetails/#properties","text":"Name Type Description Notes config SyntheticsTestConfig [optional] locations [str] Array of locations used to run the test. [optional] message str Notification message associated with the test. [optional] monitor_id int The associated monitor ID. [optional] name str Name of the test. [optional] options SyntheticsTestOptions [optional] public_id str The test public ID. [optional] status SyntheticsTestPauseStatus [optional] steps [SyntheticsStep] For browser test, the steps of the test. [optional] subtype SyntheticsTestDetailsSubType [optional] tags [str] Array of tags attached to the test. [optional] type SyntheticsTestDetailsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestDetailsSubType/","text":"SyntheticsTestDetailsSubType The subtype of the Synthetic API test, http , ssl , tcp , dns , icmp or multi . Properties Name Type Description Notes value str The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns`, `icmp` or `multi`. must be one of [\"http\", \"ssl\", \"tcp\", \"dns\", \"multi\", \"icmp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestDetailsSubType"},{"location":"v1/SyntheticsTestDetailsSubType/#syntheticstestdetailssubtype","text":"The subtype of the Synthetic API test, http , ssl , tcp , dns , icmp or multi .","title":"SyntheticsTestDetailsSubType"},{"location":"v1/SyntheticsTestDetailsSubType/#properties","text":"Name Type Description Notes value str The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns`, `icmp` or `multi`. must be one of [\"http\", \"ssl\", \"tcp\", \"dns\", \"multi\", \"icmp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestDetailsType/","text":"SyntheticsTestDetailsType Type of the Synthetic test, either api or browser . Properties Name Type Description Notes value str Type of the Synthetic test, either `api` or `browser`. must be one of [\"api\", \"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestDetailsType"},{"location":"v1/SyntheticsTestDetailsType/#syntheticstestdetailstype","text":"Type of the Synthetic test, either api or browser .","title":"SyntheticsTestDetailsType"},{"location":"v1/SyntheticsTestDetailsType/#properties","text":"Name Type Description Notes value str Type of the Synthetic test, either `api` or `browser`. must be one of [\"api\", \"browser\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestHeaders/","text":"SyntheticsTestHeaders Headers to include when performing the test. Properties Name Type Description Notes any string name str any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestHeaders"},{"location":"v1/SyntheticsTestHeaders/#syntheticstestheaders","text":"Headers to include when performing the test.","title":"SyntheticsTestHeaders"},{"location":"v1/SyntheticsTestHeaders/#properties","text":"Name Type Description Notes any string name str any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestMonitorStatus/","text":"SyntheticsTestMonitorStatus The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data Properties Name Type Description Notes value int The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data must be one of [0, 1, 2, ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestMonitorStatus"},{"location":"v1/SyntheticsTestMonitorStatus/#syntheticstestmonitorstatus","text":"The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data","title":"SyntheticsTestMonitorStatus"},{"location":"v1/SyntheticsTestMonitorStatus/#properties","text":"Name Type Description Notes value int The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data must be one of [0, 1, 2, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestOptions/","text":"SyntheticsTestOptions Object describing the extra options for a Synthetic test. Properties Name Type Description Notes accept_self_signed bool For SSL test, whether or not the test should allow self signed certificates. [optional] allow_insecure bool Allows loading insecure content for an HTTP request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] disable_cors bool Whether or not to disable CORS mechanism. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] min_failure_duration int Minimum amount of time in failure required to trigger an alert. [optional] min_location_failed int Minimum number of locations in failure required to trigger an alert. [optional] monitor_options SyntheticsTestOptionsMonitorOptions [optional] no_screenshot bool Prevents saving screenshots of the steps. [optional] retry SyntheticsTestOptionsRetry [optional] tick_every SyntheticsTickInterval [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestOptions"},{"location":"v1/SyntheticsTestOptions/#syntheticstestoptions","text":"Object describing the extra options for a Synthetic test.","title":"SyntheticsTestOptions"},{"location":"v1/SyntheticsTestOptions/#properties","text":"Name Type Description Notes accept_self_signed bool For SSL test, whether or not the test should allow self signed certificates. [optional] allow_insecure bool Allows loading insecure content for an HTTP request. [optional] device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional] disable_cors bool Whether or not to disable CORS mechanism. [optional] follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional] min_failure_duration int Minimum amount of time in failure required to trigger an alert. [optional] min_location_failed int Minimum number of locations in failure required to trigger an alert. [optional] monitor_options SyntheticsTestOptionsMonitorOptions [optional] no_screenshot bool Prevents saving screenshots of the steps. [optional] retry SyntheticsTestOptionsRetry [optional] tick_every SyntheticsTickInterval [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestOptionsMonitorOptions/","text":"SyntheticsTestOptionsMonitorOptions Object containing the options for a Synthetic test as a monitor (for example, renotification). Properties Name Type Description Notes renotify_interval int Time interval before renotifying if the test is still failing (in minutes). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestOptionsMonitorOptions"},{"location":"v1/SyntheticsTestOptionsMonitorOptions/#syntheticstestoptionsmonitoroptions","text":"Object containing the options for a Synthetic test as a monitor (for example, renotification).","title":"SyntheticsTestOptionsMonitorOptions"},{"location":"v1/SyntheticsTestOptionsMonitorOptions/#properties","text":"Name Type Description Notes renotify_interval int Time interval before renotifying if the test is still failing (in minutes). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestOptionsRetry/","text":"SyntheticsTestOptionsRetry Object describing the retry strategy to apply to a Synthetic test. Properties Name Type Description Notes count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestOptionsRetry"},{"location":"v1/SyntheticsTestOptionsRetry/#syntheticstestoptionsretry","text":"Object describing the retry strategy to apply to a Synthetic test.","title":"SyntheticsTestOptionsRetry"},{"location":"v1/SyntheticsTestOptionsRetry/#properties","text":"Name Type Description Notes count int 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestPauseStatus/","text":"SyntheticsTestPauseStatus Define whether you want to start ( live ) or pause ( paused ) a Synthetic test. Properties Name Type Description Notes value str Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. must be one of [\"live\", \"paused\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestPauseStatus"},{"location":"v1/SyntheticsTestPauseStatus/#syntheticstestpausestatus","text":"Define whether you want to start ( live ) or pause ( paused ) a Synthetic test.","title":"SyntheticsTestPauseStatus"},{"location":"v1/SyntheticsTestPauseStatus/#properties","text":"Name Type Description Notes value str Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. must be one of [\"live\", \"paused\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestProcessStatus/","text":"SyntheticsTestProcessStatus Status of a Synthetic test. Properties Name Type Description Notes value str Status of a Synthetic test. must be one of [\"not_scheduled\", \"scheduled\", \"started\", \"finished\", \"finished_with_error\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestProcessStatus"},{"location":"v1/SyntheticsTestProcessStatus/#syntheticstestprocessstatus","text":"Status of a Synthetic test.","title":"SyntheticsTestProcessStatus"},{"location":"v1/SyntheticsTestProcessStatus/#properties","text":"Name Type Description Notes value str Status of a Synthetic test. must be one of [\"not_scheduled\", \"scheduled\", \"started\", \"finished\", \"finished_with_error\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestRequest/","text":"SyntheticsTestRequest Object describing the Synthetic test request. Properties Name Type Description Notes basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] certificate SyntheticsTestRequestCertificate [optional] dns_server str DNS server to use for DNS tests. [optional] dns_server_port int DNS server port to use for DNS tests. [optional] headers SyntheticsTestHeaders [optional] host str Host name to perform the test with. [optional] method HTTPMethod [optional] no_saving_response_body bool Determines whether or not to save the response body. [optional] number_of_packets int Number of pings to use per test. [optional] port int Port to use when performing the test. [optional] query {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Query to use for the test. [optional] should_track_hops bool 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 str URL to perform the test with. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestRequest"},{"location":"v1/SyntheticsTestRequest/#syntheticstestrequest","text":"Object describing the Synthetic test request.","title":"SyntheticsTestRequest"},{"location":"v1/SyntheticsTestRequest/#properties","text":"Name Type Description Notes basic_auth SyntheticsBasicAuth [optional] body str Body to include in the test. [optional] certificate SyntheticsTestRequestCertificate [optional] dns_server str DNS server to use for DNS tests. [optional] dns_server_port int DNS server port to use for DNS tests. [optional] headers SyntheticsTestHeaders [optional] host str Host name to perform the test with. [optional] method HTTPMethod [optional] no_saving_response_body bool Determines whether or not to save the response body. [optional] number_of_packets int Number of pings to use per test. [optional] port int Port to use when performing the test. [optional] query {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Query to use for the test. [optional] should_track_hops bool 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 str URL to perform the test with. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestRequestCertificate/","text":"SyntheticsTestRequestCertificate Client certificate to use when performing the test request. Properties Name Type Description Notes cert SyntheticsTestRequestCertificateItem [optional] key SyntheticsTestRequestCertificateItem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestRequestCertificate"},{"location":"v1/SyntheticsTestRequestCertificate/#syntheticstestrequestcertificate","text":"Client certificate to use when performing the test request.","title":"SyntheticsTestRequestCertificate"},{"location":"v1/SyntheticsTestRequestCertificate/#properties","text":"Name Type Description Notes cert SyntheticsTestRequestCertificateItem [optional] key SyntheticsTestRequestCertificateItem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTestRequestCertificateItem/","text":"SyntheticsTestRequestCertificateItem Define a request certificate. Properties Name Type Description Notes content str Content of the certificate or key. [optional] filename str File name for the certificate or key. [optional] updated_at str Date of update of the certificate or key, ISO format. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTestRequestCertificateItem"},{"location":"v1/SyntheticsTestRequestCertificateItem/#syntheticstestrequestcertificateitem","text":"Define a request certificate.","title":"SyntheticsTestRequestCertificateItem"},{"location":"v1/SyntheticsTestRequestCertificateItem/#properties","text":"Name Type Description Notes content str Content of the certificate or key. [optional] filename str File name for the certificate or key. [optional] updated_at str Date of update of the certificate or key, ISO format. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTickInterval/","text":"SyntheticsTickInterval The frequency at which to run the Synthetic test (in seconds). Properties Name Type Description Notes value int The frequency at which to run the Synthetic test (in seconds). must be one of [30, 60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTickInterval"},{"location":"v1/SyntheticsTickInterval/#syntheticstickinterval","text":"The frequency at which to run the Synthetic test (in seconds).","title":"SyntheticsTickInterval"},{"location":"v1/SyntheticsTickInterval/#properties","text":"Name Type Description Notes value int The frequency at which to run the Synthetic test (in seconds). must be one of [30, 60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTiming/","text":"SyntheticsTiming Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in Synthetics documentation . 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] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTiming"},{"location":"v1/SyntheticsTiming/#syntheticstiming","text":"Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in Synthetics documentation .","title":"SyntheticsTiming"},{"location":"v1/SyntheticsTiming/#properties","text":"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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTriggerCITestLocation/","text":"SyntheticsTriggerCITestLocation Synthetics location. Properties Name Type Description Notes id int Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTriggerCITestLocation"},{"location":"v1/SyntheticsTriggerCITestLocation/#syntheticstriggercitestlocation","text":"Synthetics location.","title":"SyntheticsTriggerCITestLocation"},{"location":"v1/SyntheticsTriggerCITestLocation/#properties","text":"Name Type Description Notes id int Unique identifier of the location. [optional] name str Name of the location. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTriggerCITestRunResult/","text":"SyntheticsTriggerCITestRunResult Information about a single test run. Properties Name Type Description Notes device SyntheticsDeviceID [optional] location int The location ID of the test run. [optional] public_id str The public ID of the Synthetics test. [optional] result_id str ID of the result. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTriggerCITestRunResult"},{"location":"v1/SyntheticsTriggerCITestRunResult/#syntheticstriggercitestrunresult","text":"Information about a single test run.","title":"SyntheticsTriggerCITestRunResult"},{"location":"v1/SyntheticsTriggerCITestRunResult/#properties","text":"Name Type Description Notes device SyntheticsDeviceID [optional] location int The location ID of the test run. [optional] public_id str The public ID of the Synthetics test. [optional] result_id str ID of the result. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsTriggerCITestsResponse/","text":"SyntheticsTriggerCITestsResponse Object containing information about the tests triggered. Properties Name Type Description Notes locations [SyntheticsTriggerCITestLocation] List of Synthetics locations. [optional] results [SyntheticsTriggerCITestRunResult] Information about the tests runs. [optional] triggered_check_ids [str] The public IDs of the Synthetics test triggered. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsTriggerCITestsResponse"},{"location":"v1/SyntheticsTriggerCITestsResponse/#syntheticstriggercitestsresponse","text":"Object containing information about the tests triggered.","title":"SyntheticsTriggerCITestsResponse"},{"location":"v1/SyntheticsTriggerCITestsResponse/#properties","text":"Name Type Description Notes locations [SyntheticsTriggerCITestLocation] List of Synthetics locations. [optional] results [SyntheticsTriggerCITestRunResult] Information about the tests runs. [optional] triggered_check_ids [str] The public IDs of the Synthetics test triggered. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsUpdateTestPauseStatusPayload/","text":"SyntheticsUpdateTestPauseStatusPayload Object to start or pause an existing Synthetic test. Properties Name Type Description Notes new_status SyntheticsTestPauseStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsUpdateTestPauseStatusPayload"},{"location":"v1/SyntheticsUpdateTestPauseStatusPayload/#syntheticsupdatetestpausestatuspayload","text":"Object to start or pause an existing Synthetic test.","title":"SyntheticsUpdateTestPauseStatusPayload"},{"location":"v1/SyntheticsUpdateTestPauseStatusPayload/#properties","text":"Name Type Description Notes new_status SyntheticsTestPauseStatus [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsVariableParser/","text":"SyntheticsVariableParser Details of the parser to use for the global variable. Properties Name Type Description Notes type SyntheticsGlobalVariableParserType value str Regex or JSON path used for the parser. Not used with type `raw`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsVariableParser"},{"location":"v1/SyntheticsVariableParser/#syntheticsvariableparser","text":"Details of the parser to use for the global variable.","title":"SyntheticsVariableParser"},{"location":"v1/SyntheticsVariableParser/#properties","text":"Name Type Description Notes type SyntheticsGlobalVariableParserType value str Regex or JSON path used for the parser. Not used with type `raw`. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/SyntheticsWarningType/","text":"SyntheticsWarningType User locator used. Properties Name Type Description Notes value str User locator used. defaults to \"user_locator\", must be one of [\"user_locator\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SyntheticsWarningType"},{"location":"v1/SyntheticsWarningType/#syntheticswarningtype","text":"User locator used.","title":"SyntheticsWarningType"},{"location":"v1/SyntheticsWarningType/#properties","text":"Name Type Description Notes value str User locator used. defaults to \"user_locator\", must be one of [\"user_locator\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetCellDisplayMode/","text":"TableWidgetCellDisplayMode Define a display mode for the table cell. Properties Name Type Description Notes value str Define a display mode for the table cell. must be one of [\"number\", \"bar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetCellDisplayMode"},{"location":"v1/TableWidgetCellDisplayMode/#tablewidgetcelldisplaymode","text":"Define a display mode for the table cell.","title":"TableWidgetCellDisplayMode"},{"location":"v1/TableWidgetCellDisplayMode/#properties","text":"Name Type Description Notes value str Define a display mode for the table cell. must be one of [\"number\", \"bar\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetDefinition/","text":"TableWidgetDefinition The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key. Properties Name Type Description Notes requests [TableWidgetRequest] Widget definition. type TableWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] has_search_bar TableWidgetHasSearchBar [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetDefinition"},{"location":"v1/TableWidgetDefinition/#tablewidgetdefinition","text":"The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.","title":"TableWidgetDefinition"},{"location":"v1/TableWidgetDefinition/#properties","text":"Name Type Description Notes requests [TableWidgetRequest] Widget definition. type TableWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] has_search_bar TableWidgetHasSearchBar [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetDefinitionType/","text":"TableWidgetDefinitionType Type of the table widget. Properties Name Type Description Notes value str Type of the table widget. defaults to \"query_table\", must be one of [\"query_table\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetDefinitionType"},{"location":"v1/TableWidgetDefinitionType/#tablewidgetdefinitiontype","text":"Type of the table widget.","title":"TableWidgetDefinitionType"},{"location":"v1/TableWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the table widget. defaults to \"query_table\", must be one of [\"query_table\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetHasSearchBar/","text":"TableWidgetHasSearchBar Controls the display of the search bar. Properties Name Type Description Notes value str Controls the display of the search bar. must be one of [\"always\", \"never\", \"auto\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetHasSearchBar"},{"location":"v1/TableWidgetHasSearchBar/#tablewidgethassearchbar","text":"Controls the display of the search bar.","title":"TableWidgetHasSearchBar"},{"location":"v1/TableWidgetHasSearchBar/#properties","text":"Name Type Description Notes value str Controls the display of the search bar. must be one of [\"always\", \"never\", \"auto\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TableWidgetRequest/","text":"TableWidgetRequest Updated table widget. Properties Name Type Description Notes aggregator WidgetAggregator [optional] alias str The column name (defaults to the metric name). [optional] apm_query LogQueryDefinition [optional] apm_stats_query ApmStatsQueryDefinition [optional] cell_display_mode [TableWidgetCellDisplayMode] A list of display modes for each table cell. [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] limit int For metric queries, the number of lines to show in the table. Only one request should have this property. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TableWidgetRequest"},{"location":"v1/TableWidgetRequest/#tablewidgetrequest","text":"Updated table widget.","title":"TableWidgetRequest"},{"location":"v1/TableWidgetRequest/#properties","text":"Name Type Description Notes aggregator WidgetAggregator [optional] alias str The column name (defaults to the metric name). [optional] apm_query LogQueryDefinition [optional] apm_stats_query ApmStatsQueryDefinition [optional] cell_display_mode [TableWidgetCellDisplayMode] A list of display modes for each table cell. [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] limit int For metric queries, the number of lines to show in the table. Only one request should have this property. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] order WidgetSort [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Query definition. [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TagToHosts/","text":"TagToHosts In this object, the key is the tag, the value is a list of host names that are reporting that tag. Properties Name Type Description Notes tags {str: ([str],)} A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TagToHosts"},{"location":"v1/TagToHosts/#tagtohosts","text":"In this object, the key is the tag, the value is a list of host names that are reporting that tag.","title":"TagToHosts"},{"location":"v1/TagToHosts/#properties","text":"Name Type Description Notes tags {str: ([str],)} A list of tags to apply to the host. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TagsApi/","text":"datadog_api_client.v1.TagsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags list_host_tags GET /api/v1/tags/hosts Get Tags update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags create_host_tags HostTags create_host_tags(host_name, body) Add tags to a host This endpoint allows you to add new tags to a host, optionally specifying where these tags come from. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Update host tags request body. source = \"chef\" # str | The source of the tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). (optional) # example passing only required values which don't have defaults set try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body HostTags Update host tags request body. source str The source of the tags. Complete list of source attribute values . [optional] Return type HostTags Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_host_tags delete_host_tags(host_name) Remove host tags This endpoint allows you to remove all user-assigned tags for a single host. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to remove all user-assigned tags for a single host. source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Remove host tags api_instance.delete_host_tags(host_name) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Remove host tags api_instance.delete_host_tags(host_name, source=source) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str This endpoint allows you to remove all user-assigned tags for a single host. source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values . [optional] Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_host_tags HostTags get_host_tags(host_name) Get host tags Return the list of tags that apply to a given host. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | When specified, filters list of tags to those tags with the specified source. source = \"source_example\" # str | Source to filter. (optional) # example passing only required values which don't have defaults set try: # Get host tags api_response = api_instance.get_host_tags(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get host tags api_response = api_instance.get_host_tags(host_name, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str When specified, filters list of tags to those tags with the specified source. source str Source to filter. [optional] Return type HostTags Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_host_tags TagToHosts list_host_tags() Get Tags Return a mapping of tags to hosts for your whole infrastructure. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) source = \"source_example\" # str | When specified, filters host list to those tags with the specified source. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get Tags api_response = api_instance.list_host_tags(source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->list_host_tags: %s\\n\" % e) Parameters Name Type Description Notes source str When specified, filters host list to those tags with the specified source. [optional] Return type TagToHosts Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_host_tags HostTags update_host_tags(host_name, body) Update host tags This endpoint allows you to update/replace all tags in an integration source with those supplied in the request. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to update/replace all in an integration source with those supplied in the request. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Add tags to host source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Update host tags api_response = api_instance.update_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update host tags api_response = api_instance.update_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e) Parameters Name Type Description Notes host_name str This endpoint allows you to update/replace all in an integration source with those supplied in the request. body HostTags Add tags to host source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values [optional] Return type HostTags Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.TagsApi"},{"location":"v1/TagsApi/#datadog_api_clientv1tagsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_host_tags POST /api/v1/tags/hosts/{host_name} Add tags to a host delete_host_tags DELETE /api/v1/tags/hosts/{host_name} Remove host tags get_host_tags GET /api/v1/tags/hosts/{host_name} Get host tags list_host_tags GET /api/v1/tags/hosts Get Tags update_host_tags PUT /api/v1/tags/hosts/{host_name} Update host tags","title":"datadog_api_client.v1.TagsApi"},{"location":"v1/TagsApi/#create_host_tags","text":"HostTags create_host_tags(host_name, body) Add tags to a host This endpoint allows you to add new tags to a host, optionally specifying where these tags come from.","title":"create_host_tags"},{"location":"v1/TagsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Update host tags request body. source = \"chef\" # str | The source of the tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). (optional) # example passing only required values which don't have defaults set try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Add tags to a host api_response = api_instance.create_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->create_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters","text":"Name Type Description Notes host_name str This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. body HostTags Update host tags request body. source str The source of the tags. Complete list of source attribute values . [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type","text":"HostTags","title":"Return type"},{"location":"v1/TagsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details","text":"Status code Description Response headers 201 Created - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#delete_host_tags","text":"delete_host_tags(host_name) Remove host tags This endpoint allows you to remove all user-assigned tags for a single host.","title":"delete_host_tags"},{"location":"v1/TagsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to remove all user-assigned tags for a single host. source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Remove host tags api_instance.delete_host_tags(host_name) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Remove host tags api_instance.delete_host_tags(host_name, source=source) except ApiException as e: print(\"Exception when calling TagsApi->delete_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_1","text":"Name Type Description Notes host_name str This endpoint allows you to remove all user-assigned tags for a single host. source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values . [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v1/TagsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#get_host_tags","text":"HostTags get_host_tags(host_name) Get host tags Return the list of tags that apply to a given host.","title":"get_host_tags"},{"location":"v1/TagsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | When specified, filters list of tags to those tags with the specified source. source = \"source_example\" # str | Source to filter. (optional) # example passing only required values which don't have defaults set try: # Get host tags api_response = api_instance.get_host_tags(host_name) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get host tags api_response = api_instance.get_host_tags(host_name, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->get_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_2","text":"Name Type Description Notes host_name str When specified, filters list of tags to those tags with the specified source. source str Source to filter. [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_2","text":"HostTags","title":"Return type"},{"location":"v1/TagsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#list_host_tags","text":"TagToHosts list_host_tags() Get Tags Return a mapping of tags to hosts for your whole infrastructure.","title":"list_host_tags"},{"location":"v1/TagsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) source = \"source_example\" # str | When specified, filters host list to those tags with the specified source. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get Tags api_response = api_instance.list_host_tags(source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->list_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_3","text":"Name Type Description Notes source str When specified, filters host list to those tags with the specified source. [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_3","text":"TagToHosts","title":"Return type"},{"location":"v1/TagsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TagsApi/#update_host_tags","text":"HostTags update_host_tags(host_name, body) Update host tags This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.","title":"update_host_tags"},{"location":"v1/TagsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import tags_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tags_api.TagsApi(api_client) host_name = \"host_name_example\" # str | This endpoint allows you to update/replace all in an integration source with those supplied in the request. body = HostTags( host=\"test.host\", tags=[ \"environment:production\", ], ) # HostTags | Add tags to host source = \"source_example\" # str | 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) # example passing only required values which don't have defaults set try: # Update host tags api_response = api_instance.update_host_tags(host_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Update host tags api_response = api_instance.update_host_tags(host_name, body, source=source) pprint(api_response) except ApiException as e: print(\"Exception when calling TagsApi->update_host_tags: %s\\n\" % e)","title":"Example"},{"location":"v1/TagsApi/#parameters_4","text":"Name Type Description Notes host_name str This endpoint allows you to update/replace all in an integration source with those supplied in the request. body HostTags Add tags to host source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values [optional]","title":"Parameters"},{"location":"v1/TagsApi/#return-type_4","text":"HostTags","title":"Return type"},{"location":"v1/TagsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/TagsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/TagsApi/#http-response-details_4","text":"Status code Description Response headers 201 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/TargetFormatType/","text":"TargetFormatType If the target_type of the remapper is attribute , try to cast the value to a new specific type. If the cast is not possible, the original type is kept. string , integer , or double are the possible types. If the target_type is tag , this parameter may not be specified. Properties Name Type Description Notes value str If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. must be one of [\"auto\", \"string\", \"integer\", \"double\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TargetFormatType"},{"location":"v1/TargetFormatType/#targetformattype","text":"If the target_type of the remapper is attribute , try to cast the value to a new specific type. If the cast is not possible, the original type is kept. string , integer , or double are the possible types. If the target_type is tag , this parameter may not be specified.","title":"TargetFormatType"},{"location":"v1/TargetFormatType/#properties","text":"Name Type Description Notes value str If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. must be one of [\"auto\", \"string\", \"integer\", \"double\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetDefinition/","text":"TimeseriesWidgetDefinition The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. Properties Name Type Description Notes requests [TimeseriesWidgetRequest] List of timeseries widget requests. type TimeseriesWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] right_yaxis WidgetAxis [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetDefinition"},{"location":"v1/TimeseriesWidgetDefinition/#timeserieswidgetdefinition","text":"The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.","title":"TimeseriesWidgetDefinition"},{"location":"v1/TimeseriesWidgetDefinition/#properties","text":"Name Type Description Notes requests [TimeseriesWidgetRequest] List of timeseries widget requests. type TimeseriesWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] events [WidgetEvent] List of widget events. [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] right_yaxis WidgetAxis [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] yaxis WidgetAxis [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetDefinitionType/","text":"TimeseriesWidgetDefinitionType Type of the timeseries widget. Properties Name Type Description Notes value str Type of the timeseries widget. defaults to \"timeseries\", must be one of [\"timeseries\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetDefinitionType"},{"location":"v1/TimeseriesWidgetDefinitionType/#timeserieswidgetdefinitiontype","text":"Type of the timeseries widget.","title":"TimeseriesWidgetDefinitionType"},{"location":"v1/TimeseriesWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the timeseries widget. defaults to \"timeseries\", must be one of [\"timeseries\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetExpressionAlias/","text":"TimeseriesWidgetExpressionAlias Define an expression alias. Properties Name Type Description Notes expression str Expression name. alias_name str Expression alias. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetExpressionAlias"},{"location":"v1/TimeseriesWidgetExpressionAlias/#timeserieswidgetexpressionalias","text":"Define an expression alias.","title":"TimeseriesWidgetExpressionAlias"},{"location":"v1/TimeseriesWidgetExpressionAlias/#properties","text":"Name Type Description Notes expression str Expression name. alias_name str Expression alias. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetLegendColumn/","text":"TimeseriesWidgetLegendColumn Legend column. Properties Name Type Description Notes value str Legend column. must be one of [\"value\", \"avg\", \"sum\", \"min\", \"max\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetLegendColumn"},{"location":"v1/TimeseriesWidgetLegendColumn/#timeserieswidgetlegendcolumn","text":"Legend column.","title":"TimeseriesWidgetLegendColumn"},{"location":"v1/TimeseriesWidgetLegendColumn/#properties","text":"Name Type Description Notes value str Legend column. must be one of [\"value\", \"avg\", \"sum\", \"min\", \"max\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetLegendLayout/","text":"TimeseriesWidgetLegendLayout Layout of the legend. Properties Name Type Description Notes value str Layout of the legend. must be one of [\"auto\", \"horizontal\", \"vertical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetLegendLayout"},{"location":"v1/TimeseriesWidgetLegendLayout/#timeserieswidgetlegendlayout","text":"Layout of the legend.","title":"TimeseriesWidgetLegendLayout"},{"location":"v1/TimeseriesWidgetLegendLayout/#properties","text":"Name Type Description Notes value str Layout of the legend. must be one of [\"auto\", \"horizontal\", \"vertical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/TimeseriesWidgetRequest/","text":"TimeseriesWidgetRequest Updated timeseries widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] display_type WidgetDisplayType [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] metadata [TimeseriesWidgetExpressionAlias] Used to define expression aliases. [optional] network_query LogQueryDefinition [optional] on_right_yaxis bool Whether or not to display a second y-axis on the right. [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"TimeseriesWidgetRequest"},{"location":"v1/TimeseriesWidgetRequest/#timeserieswidgetrequest","text":"Updated timeseries widget.","title":"TimeseriesWidgetRequest"},{"location":"v1/TimeseriesWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] display_type WidgetDisplayType [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] metadata [TimeseriesWidgetExpressionAlias] Used to define expression aliases. [optional] network_query LogQueryDefinition [optional] on_right_yaxis bool Whether or not to display a second y-axis on the right. [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ToplistWidgetDefinition/","text":"ToplistWidgetDefinition The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. Properties Name Type Description Notes requests [ToplistWidgetRequest] List of top list widget requests. type ToplistWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ToplistWidgetDefinition"},{"location":"v1/ToplistWidgetDefinition/#toplistwidgetdefinition","text":"The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.","title":"ToplistWidgetDefinition"},{"location":"v1/ToplistWidgetDefinition/#properties","text":"Name Type Description Notes requests [ToplistWidgetRequest] List of top list widget requests. type ToplistWidgetDefinitionType custom_links [WidgetCustomLink] List of custom links. [optional] time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ToplistWidgetDefinitionType/","text":"ToplistWidgetDefinitionType Type of the top list widget. Properties Name Type Description Notes value str Type of the top list widget. defaults to \"toplist\", must be one of [\"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ToplistWidgetDefinitionType"},{"location":"v1/ToplistWidgetDefinitionType/#toplistwidgetdefinitiontype","text":"Type of the top list widget.","title":"ToplistWidgetDefinitionType"},{"location":"v1/ToplistWidgetDefinitionType/#properties","text":"Name Type Description Notes value str Type of the top list widget. defaults to \"toplist\", must be one of [\"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/ToplistWidgetRequest/","text":"ToplistWidgetRequest Updated top list widget. Properties Name Type Description Notes apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ToplistWidgetRequest"},{"location":"v1/ToplistWidgetRequest/#toplistwidgetrequest","text":"Updated top list widget.","title":"ToplistWidgetRequest"},{"location":"v1/ToplistWidgetRequest/#properties","text":"Name Type Description Notes apm_query LogQueryDefinition [optional] conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional] event_query LogQueryDefinition [optional] formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional] log_query LogQueryDefinition [optional] network_query LogQueryDefinition [optional] process_query ProcessQueryDefinition [optional] profile_metrics_query LogQueryDefinition [optional] q str Widget query. [optional] queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional] response_format FormulaAndFunctionResponseFormat [optional] rum_query LogQueryDefinition [optional] security_query LogQueryDefinition [optional] style WidgetRequestStyle [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAnalyzedLogsHour/","text":"UsageAnalyzedLogsHour The number of analyzed logs for each hour for a given organization. Properties Name Type Description Notes analyzed_logs int Contains the number of analyzed logs. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAnalyzedLogsHour"},{"location":"v1/UsageAnalyzedLogsHour/#usageanalyzedlogshour","text":"The number of analyzed logs for each hour for a given organization.","title":"UsageAnalyzedLogsHour"},{"location":"v1/UsageAnalyzedLogsHour/#properties","text":"Name Type Description Notes analyzed_logs int Contains the number of analyzed logs. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAnalyzedLogsResponse/","text":"UsageAnalyzedLogsResponse A response containing the number of analyzed logs for each hour for a given organization. Properties Name Type Description Notes usage [UsageAnalyzedLogsHour] Get hourly usage for analyzed logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAnalyzedLogsResponse"},{"location":"v1/UsageAnalyzedLogsResponse/#usageanalyzedlogsresponse","text":"A response containing the number of analyzed logs for each hour for a given organization.","title":"UsageAnalyzedLogsResponse"},{"location":"v1/UsageAnalyzedLogsResponse/#properties","text":"Name Type Description Notes usage [UsageAnalyzedLogsHour] Get hourly usage for analyzed logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionAggregates/","text":"UsageAttributionAggregates An array of available aggregates. Properties Name Type Description Notes value [UsageAttributionAggregatesBody] An array of available aggregates. [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionAggregates"},{"location":"v1/UsageAttributionAggregates/#usageattributionaggregates","text":"An array of available aggregates.","title":"UsageAttributionAggregates"},{"location":"v1/UsageAttributionAggregates/#properties","text":"Name Type Description Notes value [UsageAttributionAggregatesBody] An array of available aggregates. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionAggregatesBody/","text":"UsageAttributionAggregatesBody The object containing the aggregates. Properties Name Type Description Notes agg_type str The aggregate type. [optional] field str The field. [optional] value float The value for a given field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionAggregatesBody"},{"location":"v1/UsageAttributionAggregatesBody/#usageattributionaggregatesbody","text":"The object containing the aggregates.","title":"UsageAttributionAggregatesBody"},{"location":"v1/UsageAttributionAggregatesBody/#properties","text":"Name Type Description Notes agg_type str The aggregate type. [optional] field str The field. [optional] value float The value for a given field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionBody/","text":"UsageAttributionBody Usage Summary by tag for a given organization. Properties Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. [optional] org_name str The name of the organization. [optional] public_id str The organization public ID. [optional] tags UsageAttributionTagNames [optional] updated_at str Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional] values UsageAttributionValues [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionBody"},{"location":"v1/UsageAttributionBody/#usageattributionbody","text":"Usage Summary by tag for a given organization.","title":"UsageAttributionBody"},{"location":"v1/UsageAttributionBody/#properties","text":"Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. [optional] org_name str The name of the organization. [optional] public_id str The organization public ID. [optional] tags UsageAttributionTagNames [optional] updated_at str Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional] values UsageAttributionValues [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionMetadata/","text":"UsageAttributionMetadata The object containing document metadata. Properties Name Type Description Notes aggregates UsageAttributionAggregates [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionMetadata"},{"location":"v1/UsageAttributionMetadata/#usageattributionmetadata","text":"The object containing document metadata.","title":"UsageAttributionMetadata"},{"location":"v1/UsageAttributionMetadata/#properties","text":"Name Type Description Notes aggregates UsageAttributionAggregates [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionPagination/","text":"UsageAttributionPagination The page count for the current pagination. Properties Name Type Description Notes limit int Maximum amount of records to be returned. [optional] offset int Records to be skipped before beginning to return. [optional] sort_direction str Direction to sort by. [optional] sort_name str Field to sort by. [optional] total_number_of_records int Total number of records. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionPagination"},{"location":"v1/UsageAttributionPagination/#usageattributionpagination","text":"The page count for the current pagination.","title":"UsageAttributionPagination"},{"location":"v1/UsageAttributionPagination/#properties","text":"Name Type Description Notes limit int Maximum amount of records to be returned. [optional] offset int Records to be skipped before beginning to return. [optional] sort_direction str Direction to sort by. [optional] sort_name str Field to sort by. [optional] total_number_of_records int Total number of records. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionResponse/","text":"UsageAttributionResponse Response containing the Usage Summary by tag(s). Properties Name Type Description Notes metadata UsageAttributionMetadata [optional] usage [UsageAttributionBody] Get Usage Summary by tag(s). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionResponse"},{"location":"v1/UsageAttributionResponse/#usageattributionresponse","text":"Response containing the Usage Summary by tag(s).","title":"UsageAttributionResponse"},{"location":"v1/UsageAttributionResponse/#properties","text":"Name Type Description Notes metadata UsageAttributionMetadata [optional] usage [UsageAttributionBody] Get Usage Summary by tag(s). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionSort/","text":"UsageAttributionSort The field to sort by. Properties Name Type Description Notes value str The field to sort by. defaults to \"custom_timeseries_usage\", must be one of [\"api_percentage\", \"snmp_usage\", \"apm_host_usage\", \"api_usage\", \"container_usage\", \"custom_timeseries_percentage\", \"container_percentage\", \"apm_host_percentage\", \"npm_host_percentage\", \"browser_percentage\", \"browser_usage\", \"infra_host_percentage\", \"snmp_percentage\", \"npm_host_usage\", \"infra_host_usage\", \"custom_timeseries_usage\", \"lambda_functions_usage\", \"lambda_functions_percentage\", \"lambda_invocations_usage\", \"lambda_invocations_percentage\", \"lambda_usage\", \"lambda_percentage\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionSort"},{"location":"v1/UsageAttributionSort/#usageattributionsort","text":"The field to sort by.","title":"UsageAttributionSort"},{"location":"v1/UsageAttributionSort/#properties","text":"Name Type Description Notes value str The field to sort by. defaults to \"custom_timeseries_usage\", must be one of [\"api_percentage\", \"snmp_usage\", \"apm_host_usage\", \"api_usage\", \"container_usage\", \"custom_timeseries_percentage\", \"container_percentage\", \"apm_host_percentage\", \"npm_host_percentage\", \"browser_percentage\", \"browser_usage\", \"infra_host_percentage\", \"snmp_percentage\", \"npm_host_usage\", \"infra_host_usage\", \"custom_timeseries_usage\", \"lambda_functions_usage\", \"lambda_functions_percentage\", \"lambda_invocations_usage\", \"lambda_invocations_percentage\", \"lambda_usage\", \"lambda_percentage\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionTagNames/","text":"UsageAttributionTagNames Usage Summary by tag name. Properties Name Type Description Notes any string name [str] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionTagNames"},{"location":"v1/UsageAttributionTagNames/#usageattributiontagnames","text":"Usage Summary by tag name.","title":"UsageAttributionTagNames"},{"location":"v1/UsageAttributionTagNames/#properties","text":"Name Type Description Notes any string name [str] any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageAttributionValues/","text":"UsageAttributionValues Fields in Usage Summary by tag(s). 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] 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] 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_containers_percentage float The percentage of profiled containers usage by tag(s). [optional] profiled_containers_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] [Back to Model list] [Back to API list] [Back to README]","title":"UsageAttributionValues"},{"location":"v1/UsageAttributionValues/#usageattributionvalues","text":"Fields in Usage Summary by tag(s).","title":"UsageAttributionValues"},{"location":"v1/UsageAttributionValues/#properties","text":"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] 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] 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_containers_percentage float The percentage of profiled containers usage by tag(s). [optional] profiled_containers_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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryBody/","text":"UsageBillableSummaryBody Response with properties for each aggregated usage type. Properties Name Type Description Notes account_billable_usage int The total account usage. [optional] elapsed_usage_hours int Elapsed usage hours for some billable product. [optional] first_billable_usage_hour datetime The first billable hour for the org. [optional] last_billable_usage_hour datetime The last billable hour for the org. [optional] org_billable_usage int 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 str Units pertaining to the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryBody"},{"location":"v1/UsageBillableSummaryBody/#usagebillablesummarybody","text":"Response with properties for each aggregated usage type.","title":"UsageBillableSummaryBody"},{"location":"v1/UsageBillableSummaryBody/#properties","text":"Name Type Description Notes account_billable_usage int The total account usage. [optional] elapsed_usage_hours int Elapsed usage hours for some billable product. [optional] first_billable_usage_hour datetime The first billable hour for the org. [optional] last_billable_usage_hour datetime The last billable hour for the org. [optional] org_billable_usage int 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 str Units pertaining to the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryHour/","text":"UsageBillableSummaryHour Response with monthly summary of data billed by Datadog. Properties Name Type Description Notes billing_plan str The billing plan. [optional] end_date datetime Shows the last date of usage. [optional] num_orgs int The number of organizations. [optional] org_name str The organization name. [optional] public_id str The organization public ID. [optional] ratio_in_month int Shows usage aggregation for a billing period. [optional] start_date datetime Shows the first date of usage. [optional] usage UsageBillableSummaryKeys [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryHour"},{"location":"v1/UsageBillableSummaryHour/#usagebillablesummaryhour","text":"Response with monthly summary of data billed by Datadog.","title":"UsageBillableSummaryHour"},{"location":"v1/UsageBillableSummaryHour/#properties","text":"Name Type Description Notes billing_plan str The billing plan. [optional] end_date datetime Shows the last date of usage. [optional] num_orgs int The number of organizations. [optional] org_name str The organization name. [optional] public_id str The organization public ID. [optional] ratio_in_month int Shows usage aggregation for a billing period. [optional] start_date datetime Shows the first date of usage. [optional] usage UsageBillableSummaryKeys [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryKeys/","text":"UsageBillableSummaryKeys Response with aggregated usage types. Properties Name Type Description Notes apm_host_sum UsageBillableSummaryBody [optional] apm_host_top99p UsageBillableSummaryBody [optional] apm_trace_search_sum UsageBillableSummaryBody [optional] fargate_container_average UsageBillableSummaryBody [optional] infra_container_sum UsageBillableSummaryBody [optional] infra_host_sum UsageBillableSummaryBody [optional] infra_host_top99p UsageBillableSummaryBody [optional] iot_top99p UsageBillableSummaryBody [optional] lambda_function_average UsageBillableSummaryBody [optional] logs_indexed_sum UsageBillableSummaryBody [optional] logs_ingested_sum UsageBillableSummaryBody [optional] npm_flow_sum UsageBillableSummaryBody [optional] npm_host_top99p UsageBillableSummaryBody [optional] rum_sum UsageBillableSummaryBody [optional] serverless_invocation_sum UsageBillableSummaryBody [optional] siem_sum UsageBillableSummaryBody [optional] synthetics_api_tests_sum UsageBillableSummaryBody [optional] synthetics_browser_checks_sum UsageBillableSummaryBody [optional] timeseries_average UsageBillableSummaryBody [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryKeys"},{"location":"v1/UsageBillableSummaryKeys/#usagebillablesummarykeys","text":"Response with aggregated usage types.","title":"UsageBillableSummaryKeys"},{"location":"v1/UsageBillableSummaryKeys/#properties","text":"Name Type Description Notes apm_host_sum UsageBillableSummaryBody [optional] apm_host_top99p UsageBillableSummaryBody [optional] apm_trace_search_sum UsageBillableSummaryBody [optional] fargate_container_average UsageBillableSummaryBody [optional] infra_container_sum UsageBillableSummaryBody [optional] infra_host_sum UsageBillableSummaryBody [optional] infra_host_top99p UsageBillableSummaryBody [optional] iot_top99p UsageBillableSummaryBody [optional] lambda_function_average UsageBillableSummaryBody [optional] logs_indexed_sum UsageBillableSummaryBody [optional] logs_ingested_sum UsageBillableSummaryBody [optional] npm_flow_sum UsageBillableSummaryBody [optional] npm_host_top99p UsageBillableSummaryBody [optional] rum_sum UsageBillableSummaryBody [optional] serverless_invocation_sum UsageBillableSummaryBody [optional] siem_sum UsageBillableSummaryBody [optional] synthetics_api_tests_sum UsageBillableSummaryBody [optional] synthetics_browser_checks_sum UsageBillableSummaryBody [optional] timeseries_average UsageBillableSummaryBody [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageBillableSummaryResponse/","text":"UsageBillableSummaryResponse Response with monthly summary of data billed by Datadog. Properties Name Type Description Notes usage [UsageBillableSummaryHour] An array of objects regarding usage of billable summary. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageBillableSummaryResponse"},{"location":"v1/UsageBillableSummaryResponse/#usagebillablesummaryresponse","text":"Response with monthly summary of data billed by Datadog.","title":"UsageBillableSummaryResponse"},{"location":"v1/UsageBillableSummaryResponse/#properties","text":"Name Type Description Notes usage [UsageBillableSummaryHour] An array of objects regarding usage of billable summary. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageComplianceHour/","text":"UsageComplianceHour Compliance Monitoring usage for a given organization for a given hour. Properties Name Type Description Notes compliance_container_count int The total number of compliance container hours from the start of the given hour's month until the given hour. [optional] compliance_host_count int The total number of compliance hosts hours from the start of the given hour's month until the given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageComplianceHour"},{"location":"v1/UsageComplianceHour/#usagecompliancehour","text":"Compliance Monitoring usage for a given organization for a given hour.","title":"UsageComplianceHour"},{"location":"v1/UsageComplianceHour/#properties","text":"Name Type Description Notes compliance_container_count int The total number of compliance container hours from the start of the given hour's month until the given hour. [optional] compliance_host_count int The total number of compliance hosts hours from the start of the given hour's month until the given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageComplianceResponse/","text":"UsageComplianceResponse The response containing the Compliance Monitoring usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageComplianceHour] Get hourly usage for Compliance Monitoring. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageComplianceResponse"},{"location":"v1/UsageComplianceResponse/#usagecomplianceresponse","text":"The response containing the Compliance Monitoring usage for each hour for a given organization.","title":"UsageComplianceResponse"},{"location":"v1/UsageComplianceResponse/#properties","text":"Name Type Description Notes usage [UsageComplianceHour] Get hourly usage for Compliance Monitoring. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsAttributes/","text":"UsageCustomReportsAttributes The response containing attributes for custom reports. Properties Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of custom report. [optional] size int size [optional] start_date str The starting date of custom report. [optional] tags [str] A list of tags to apply to custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsAttributes"},{"location":"v1/UsageCustomReportsAttributes/#usagecustomreportsattributes","text":"The response containing attributes for custom reports.","title":"UsageCustomReportsAttributes"},{"location":"v1/UsageCustomReportsAttributes/#properties","text":"Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of custom report. [optional] size int size [optional] start_date str The starting date of custom report. [optional] tags [str] A list of tags to apply to custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsData/","text":"UsageCustomReportsData The response containing the date and type for custom reports. Properties Name Type Description Notes attributes UsageCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsData"},{"location":"v1/UsageCustomReportsData/#usagecustomreportsdata","text":"The response containing the date and type for custom reports.","title":"UsageCustomReportsData"},{"location":"v1/UsageCustomReportsData/#properties","text":"Name Type Description Notes attributes UsageCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsMeta/","text":"UsageCustomReportsMeta The object containing document metadata. Properties Name Type Description Notes page UsageCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsMeta"},{"location":"v1/UsageCustomReportsMeta/#usagecustomreportsmeta","text":"The object containing document metadata.","title":"UsageCustomReportsMeta"},{"location":"v1/UsageCustomReportsMeta/#properties","text":"Name Type Description Notes page UsageCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsPage/","text":"UsageCustomReportsPage The object containing page total count. Properties Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsPage"},{"location":"v1/UsageCustomReportsPage/#usagecustomreportspage","text":"The object containing page total count.","title":"UsageCustomReportsPage"},{"location":"v1/UsageCustomReportsPage/#properties","text":"Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageCustomReportsResponse/","text":"UsageCustomReportsResponse Response containing available custom reports. Properties Name Type Description Notes data [UsageCustomReportsData] An array of available custom reports. [optional] meta UsageCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageCustomReportsResponse"},{"location":"v1/UsageCustomReportsResponse/#usagecustomreportsresponse","text":"Response containing available custom reports.","title":"UsageCustomReportsResponse"},{"location":"v1/UsageCustomReportsResponse/#properties","text":"Name Type Description Notes data [UsageCustomReportsData] An array of available custom reports. [optional] meta UsageCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageFargateHour/","text":"UsageFargateHour Number of Fargate tasks run and hourly usage. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] tasks_count int The number of Fargate tasks run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageFargateHour"},{"location":"v1/UsageFargateHour/#usagefargatehour","text":"Number of Fargate tasks run and hourly usage.","title":"UsageFargateHour"},{"location":"v1/UsageFargateHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] tasks_count int The number of Fargate tasks run. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageFargateResponse/","text":"UsageFargateResponse Response containing the number of Fargate tasks run and hourly usage. Properties Name Type Description Notes usage [UsageFargateHour] Array with the number of hourly Fargate tasks recorded for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageFargateResponse"},{"location":"v1/UsageFargateResponse/#usagefargateresponse","text":"Response containing the number of Fargate tasks run and hourly usage.","title":"UsageFargateResponse"},{"location":"v1/UsageFargateResponse/#properties","text":"Name Type Description Notes usage [UsageFargateHour] Array with the number of hourly Fargate tasks recorded for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageHostHour/","text":"UsageHostHour Number of hosts/containers recorded for each hour for a given organization. Properties Name Type Description Notes agent_host_count int Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. [optional] alibaba_host_count int 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 int Contains the total number of Azure App Services hosts using APM. [optional] apm_host_count int Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). [optional] aws_host_count int Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). [optional] azure_host_count int Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). [optional] container_count int Shows the total number of containers reported by the Docker integration during the hour. [optional] gcp_host_count int Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). [optional] heroku_host_count int Contains the total number of Heroku dynos reported by the Datadog Agent. [optional] host_count int 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 datetime The hour for the usage. [optional] infra_azure_app_service int 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 int Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. [optional] vsphere_host_count int Contains the total number of hosts that reported via vSphere integration (and were NOT running the Datadog Agent). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageHostHour"},{"location":"v1/UsageHostHour/#usagehosthour","text":"Number of hosts/containers recorded for each hour for a given organization.","title":"UsageHostHour"},{"location":"v1/UsageHostHour/#properties","text":"Name Type Description Notes agent_host_count int Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. [optional] alibaba_host_count int 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 int Contains the total number of Azure App Services hosts using APM. [optional] apm_host_count int Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). [optional] aws_host_count int Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). [optional] azure_host_count int Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). [optional] container_count int Shows the total number of containers reported by the Docker integration during the hour. [optional] gcp_host_count int Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). [optional] heroku_host_count int Contains the total number of Heroku dynos reported by the Datadog Agent. [optional] host_count int 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 datetime The hour for the usage. [optional] infra_azure_app_service int 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 int Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. [optional] vsphere_host_count int Contains the total number of hosts that reported via vSphere integration (and were NOT running the Datadog Agent). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageHostsResponse/","text":"UsageHostsResponse Host usage response. Properties Name Type Description Notes usage [UsageHostHour] An array of objects related to host usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageHostsResponse"},{"location":"v1/UsageHostsResponse/#usagehostsresponse","text":"Host usage response.","title":"UsageHostsResponse"},{"location":"v1/UsageHostsResponse/#properties","text":"Name Type Description Notes usage [UsageHostHour] An array of objects related to host usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIncidentManagementHour/","text":"UsageIncidentManagementHour Incident management usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] monthly_active_users int Contains the total number monthly active users from the start of the given hour's month until the given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIncidentManagementHour"},{"location":"v1/UsageIncidentManagementHour/#usageincidentmanagementhour","text":"Incident management usage for a given organization for a given hour.","title":"UsageIncidentManagementHour"},{"location":"v1/UsageIncidentManagementHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] monthly_active_users int Contains the total number monthly active users from the start of the given hour's month until the given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIncidentManagementResponse/","text":"UsageIncidentManagementResponse Response containing the incident management usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageIncidentManagementHour] Get hourly usage for incident management. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIncidentManagementResponse"},{"location":"v1/UsageIncidentManagementResponse/#usageincidentmanagementresponse","text":"Response containing the incident management usage for each hour for a given organization.","title":"UsageIncidentManagementResponse"},{"location":"v1/UsageIncidentManagementResponse/#properties","text":"Name Type Description Notes usage [UsageIncidentManagementHour] Get hourly usage for incident management. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIndexedSpansHour/","text":"UsageIndexedSpansHour The hours of indexed spans usage. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIndexedSpansHour"},{"location":"v1/UsageIndexedSpansHour/#usageindexedspanshour","text":"The hours of indexed spans usage.","title":"UsageIndexedSpansHour"},{"location":"v1/UsageIndexedSpansHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIndexedSpansResponse/","text":"UsageIndexedSpansResponse A response containing indexed spans usage. Properties Name Type Description Notes usage [UsageIndexedSpansHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIndexedSpansResponse"},{"location":"v1/UsageIndexedSpansResponse/#usageindexedspansresponse","text":"A response containing indexed spans usage.","title":"UsageIndexedSpansResponse"},{"location":"v1/UsageIndexedSpansResponse/#properties","text":"Name Type Description Notes usage [UsageIndexedSpansHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIngestedSpansHour/","text":"UsageIngestedSpansHour Ingested spans usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIngestedSpansHour"},{"location":"v1/UsageIngestedSpansHour/#usageingestedspanshour","text":"Ingested spans usage for a given organization for a given hour.","title":"UsageIngestedSpansHour"},{"location":"v1/UsageIngestedSpansHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIngestedSpansResponse/","text":"UsageIngestedSpansResponse Response containing the ingested spans usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageIngestedSpansHour] Get hourly usage for ingested spans. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIngestedSpansResponse"},{"location":"v1/UsageIngestedSpansResponse/#usageingestedspansresponse","text":"Response containing the ingested spans usage for each hour for a given organization.","title":"UsageIngestedSpansResponse"},{"location":"v1/UsageIngestedSpansResponse/#properties","text":"Name Type Description Notes usage [UsageIngestedSpansHour] Get hourly usage for ingested spans. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIoTHour/","text":"UsageIoTHour IoT usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] iot_device_count int The total number of IoT devices during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIoTHour"},{"location":"v1/UsageIoTHour/#usageiothour","text":"IoT usage for a given organization for a given hour.","title":"UsageIoTHour"},{"location":"v1/UsageIoTHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] iot_device_count int The total number of IoT devices during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageIoTResponse/","text":"UsageIoTResponse Response containing the IoT usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageIoTHour] Get hourly usage for IoT. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageIoTResponse"},{"location":"v1/UsageIoTResponse/#usageiotresponse","text":"Response containing the IoT usage for each hour for a given organization.","title":"UsageIoTResponse"},{"location":"v1/UsageIoTResponse/#properties","text":"Name Type Description Notes usage [UsageIoTHour] Get hourly usage for IoT. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLambdaHour/","text":"UsageLambdaHour Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization. Properties Name Type Description Notes func_count int Contains the number of different functions for each region and AWS account. [optional] hour datetime The hour for the usage. [optional] invocations_sum int Contains the sum of invocations of all functions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLambdaHour"},{"location":"v1/UsageLambdaHour/#usagelambdahour","text":"Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.","title":"UsageLambdaHour"},{"location":"v1/UsageLambdaHour/#properties","text":"Name Type Description Notes func_count int Contains the number of different functions for each region and AWS account. [optional] hour datetime The hour for the usage. [optional] invocations_sum int Contains the sum of invocations of all functions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLambdaResponse/","text":"UsageLambdaResponse Response containing the number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization. Properties Name Type Description Notes usage [UsageLambdaHour] Get hourly usage for Lambda. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLambdaResponse"},{"location":"v1/UsageLambdaResponse/#usagelambdaresponse","text":"Response containing the number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.","title":"UsageLambdaResponse"},{"location":"v1/UsageLambdaResponse/#properties","text":"Name Type Description Notes usage [UsageLambdaHour] Get hourly usage for Lambda. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByIndexHour/","text":"UsageLogsByIndexHour Number of indexed logs for each hour and index for a given organization. Properties Name Type Description Notes event_count int The total number of indexed logs for the queried hour. [optional] hour datetime The hour for the usage. [optional] index_id str The index ID for this usage. [optional] index_name str The user specified name for this index ID. [optional] retention int The retention period (in days) for this index ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByIndexHour"},{"location":"v1/UsageLogsByIndexHour/#usagelogsbyindexhour","text":"Number of indexed logs for each hour and index for a given organization.","title":"UsageLogsByIndexHour"},{"location":"v1/UsageLogsByIndexHour/#properties","text":"Name Type Description Notes event_count int The total number of indexed logs for the queried hour. [optional] hour datetime The hour for the usage. [optional] index_id str The index ID for this usage. [optional] index_name str The user specified name for this index ID. [optional] retention int The retention period (in days) for this index ID. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByIndexResponse/","text":"UsageLogsByIndexResponse Response containing the number of indexed logs for each hour and index for a given organization. Properties Name Type Description Notes usage [UsageLogsByIndexHour] An array of objects regarding hourly usage of logs by index response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByIndexResponse"},{"location":"v1/UsageLogsByIndexResponse/#usagelogsbyindexresponse","text":"Response containing the number of indexed logs for each hour and index for a given organization.","title":"UsageLogsByIndexResponse"},{"location":"v1/UsageLogsByIndexResponse/#properties","text":"Name Type Description Notes usage [UsageLogsByIndexHour] An array of objects regarding hourly usage of logs by index response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByRetentionHour/","text":"UsageLogsByRetentionHour The number of indexed logs for each hour for a given organization broken down by retention period. Properties Name Type Description Notes indexed_events_count int Total logs indexed with this retention period during a given hour. [optional] live_indexed_events_count int Live logs indexed with this retention period during a given hour. [optional] rehydrated_indexed_events_count int Rehydrated logs indexed with this retention period during a given hour. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByRetentionHour"},{"location":"v1/UsageLogsByRetentionHour/#usagelogsbyretentionhour","text":"The number of indexed logs for each hour for a given organization broken down by retention period.","title":"UsageLogsByRetentionHour"},{"location":"v1/UsageLogsByRetentionHour/#properties","text":"Name Type Description Notes indexed_events_count int Total logs indexed with this retention period during a given hour. [optional] live_indexed_events_count int Live logs indexed with this retention period during a given hour. [optional] rehydrated_indexed_events_count int Rehydrated logs indexed with this retention period during a given hour. [optional] retention str The retention period in days or \\\"custom\\\" for all custom retention usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsByRetentionResponse/","text":"UsageLogsByRetentionResponse Response containing the indexed logs usage broken down by retention period for an organization during a given hour. Properties Name Type Description Notes usage [UsageLogsByRetentionHour] Get hourly usage for indexed logs by retention period. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsByRetentionResponse"},{"location":"v1/UsageLogsByRetentionResponse/#usagelogsbyretentionresponse","text":"Response containing the indexed logs usage broken down by retention period for an organization during a given hour.","title":"UsageLogsByRetentionResponse"},{"location":"v1/UsageLogsByRetentionResponse/#properties","text":"Name Type Description Notes usage [UsageLogsByRetentionHour] Get hourly usage for indexed logs by retention period. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsHour/","text":"UsageLogsHour Hour usage for logs. Properties Name Type Description Notes billable_ingested_bytes int Contains the number of billable log bytes ingested. [optional] hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of log events indexed. [optional] ingested_events_bytes int Contains the number of log bytes ingested. [optional] logs_live_indexed_count int Contains the number of live log events indexed (data available as of December 1, 2020). [optional] logs_live_ingested_bytes int Contains the number of live log bytes ingested (data available as of December 1, 2020). [optional] logs_rehydrated_indexed_count int Contains the number of rehydrated log events indexed (data available as of December 1, 2020). [optional] logs_rehydrated_ingested_bytes int Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsHour"},{"location":"v1/UsageLogsHour/#usagelogshour","text":"Hour usage for logs.","title":"UsageLogsHour"},{"location":"v1/UsageLogsHour/#properties","text":"Name Type Description Notes billable_ingested_bytes int Contains the number of billable log bytes ingested. [optional] hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of log events indexed. [optional] ingested_events_bytes int Contains the number of log bytes ingested. [optional] logs_live_indexed_count int Contains the number of live log events indexed (data available as of December 1, 2020). [optional] logs_live_ingested_bytes int Contains the number of live log bytes ingested (data available as of December 1, 2020). [optional] logs_rehydrated_indexed_count int Contains the number of rehydrated log events indexed (data available as of December 1, 2020). [optional] logs_rehydrated_ingested_bytes int Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageLogsResponse/","text":"UsageLogsResponse Response containing the number of logs for each hour. Properties Name Type Description Notes usage [UsageLogsHour] An array of objects regarding hourly usage of logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageLogsResponse"},{"location":"v1/UsageLogsResponse/#usagelogsresponse","text":"Response containing the number of logs for each hour.","title":"UsageLogsResponse"},{"location":"v1/UsageLogsResponse/#properties","text":"Name Type Description Notes usage [UsageLogsHour] An array of objects regarding hourly usage of logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageMeteringApi/","text":"datadog_api_client.v1.UsageMeteringApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search get_daily_custom_reports UsageCustomReportsResponse get_daily_custom_reports() Get the list of available daily custom reports Get daily custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response. `[default=60]`. (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available daily custom reports api_response = api_instance.get_daily_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_daily_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes page_size int The number of files to return in the response. `[default=60]`. [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional] Return type UsageCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident_management UsageIncidentManagementResponse get_incident_management(start_hr) Get hourly usage for incident management Get hourly usage for incident management. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIncidentManagementResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_ingested_spans UsageIngestedSpansResponse get_ingested_spans(start_hr) Get hourly usage for ingested spans Get hourly usage for ingested spans. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIngestedSpansResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_monthly_custom_reports UsageCustomReportsResponse get_monthly_custom_reports() Get the list of available monthly custom reports Get monthly custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response `[default=60].` (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available monthly custom reports api_response = api_instance.get_monthly_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_monthly_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes page_size int The number of files to return in the response `[default=60].` [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional] Return type UsageCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_specified_daily_custom_reports UsageSpecifiedCustomReportsResponse get_specified_daily_custom_reports(report_id) Get specified daily custom reports Get specified daily custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified daily custom reports api_response = api_instance.get_specified_daily_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_daily_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes report_id str The specified ID to search results for. Return type UsageSpecifiedCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_specified_monthly_custom_reports UsageSpecifiedCustomReportsResponse get_specified_monthly_custom_reports(report_id) Get specified monthly custom reports Get specified monthly custom reports. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified monthly custom reports api_response = api_instance.get_specified_monthly_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_monthly_custom_reports: %s\\n\" % e) Parameters Name Type Description Notes report_id str The specified ID to search results for. Return type UsageSpecifiedCustomReportsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_tracing_without_limits UsageTracingWithoutLimitsResponse get_tracing_without_limits(start_hr) Get hourly usage for tracing without limits Get hourly usage for tracing without limits. Note This endpoint has been renamed to /api/v1/usage/ingested-spans . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageTracingWithoutLimitsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_analyzed_logs UsageAnalyzedLogsResponse get_usage_analyzed_logs(start_hr) Get hourly usage for analyzed logs Get hourly usage for analyzed logs (Security Monitoring). Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageAnalyzedLogsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_attribution UsageAttributionResponse get_usage_attribution(start_month, fields) Get Usage Attribution Get Usage Attribution. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_usage_attribution\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields = \"fields_example\" # str | The specified field to search results for. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) sort_direction = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort_name = UsageAttributionSort(\"custom_timeseries_usage\") # UsageAttributionSort | The field to sort by. (optional) # example passing only required values which don't have defaults set try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields, end_month=end_month, sort_direction=sort_direction, sort_name=sort_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e) Parameters Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields str The specified field to search results for. end_month datetime 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] sort_name UsageAttributionSort The field to sort by. [optional] Return type UsageAttributionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_billable_summary UsageBillableSummaryResponse get_usage_billable_summary() Get billable usage across your account Get billable usage across your account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get billable usage across your account api_response = api_instance.get_usage_billable_summary(month=month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_billable_summary: %s\\n\" % e) Parameters Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. [optional] Return type UsageBillableSummaryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_compliance_monitoring UsageComplianceResponse get_usage_compliance_monitoring(start_hr) Get hourly usage for Compliance Monitoring Get hourly usage for Compliance Monitoring. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageComplianceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_fargate UsageFargateResponse get_usage_fargate(start_hr) Get hourly usage for Fargate Get hourly usage for Fargate . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageFargateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_hosts UsageHostsResponse get_usage_hosts(start_hr) Get hourly usage for hosts and containers Get hourly usage for hosts and containers. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageHostsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_indexed_spans UsageIndexedSpansResponse get_usage_indexed_spans(start_hr) Get hourly usage for indexed spans Get hourly usage for indexed spans. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIndexedSpansResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_internet_of_things UsageIoTResponse get_usage_internet_of_things(start_hr) Get hourly usage for IoT Get hourly usage for IoT. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageIoTResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_lambda UsageLambdaResponse get_usage_lambda(start_hr) Get hourly usage for Lambda Get hourly usage for lambda. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageLambdaResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_logs UsageLogsResponse get_usage_logs(start_hr) Get hourly usage for Logs Get hourly usage for logs. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageLogsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_logs_by_index UsageLogsByIndexResponse get_usage_logs_by_index(start_hr) Get hourly usage for Logs by Index Get hourly usage for logs by index. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) index_name = [ \"index_name_example\", ] # [str] | Comma-separated list of log index names. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr, end_hr=end_hr, index_name=index_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] index_name [str] Comma-separated list of log index names. [optional] Return type UsageLogsByIndexResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_logs_by_retention UsageLogsByRetentionResponse get_usage_logs_by_retention(start_hr) Get hourly logs usage by retention Get hourly usage for indexed logs by retention period. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageLogsByRetentionResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_network_flows UsageNetworkFlowsResponse get_usage_network_flows(start_hr) Get hourly usage for Network Flows Get hourly usage for network flows. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageNetworkFlowsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_network_hosts UsageNetworkHostsResponse get_usage_network_hosts(start_hr) Get hourly usage for Network Hosts Get hourly usage for network hosts. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageNetworkHostsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_profiling UsageProfilingResponse get_usage_profiling(start_hr) Get hourly usage for profiled hosts Get hourly usage for profiled hosts. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageProfilingResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_rum_sessions UsageRumSessionsResponse get_usage_rum_sessions(start_hr) Get hourly usage for RUM Sessions Get hourly usage for RUM Sessions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) type = \"type_example\" # str | RUM type: `[browser, mobile]`. Defaults to `browser`. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr, end_hr=end_hr, type=type) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] type str RUM type: `[browser, mobile]`. Defaults to `browser`. [optional] Return type UsageRumSessionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_snmp UsageSNMPResponse get_usage_snmp(start_hr) Get hourly usage for SNMP devices Get hourly usage for SNMP devices. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional] Return type UsageSNMPResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_summary UsageSummaryResponse get_usage_summary(start_month) Get usage across your multi-org account Get usage across your multi-org account. You must have the multi-org feature enabled. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) include_org_details = True # bool | Include usage summaries for each sub-org. (optional) # example passing only required values which don't have defaults set try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month, end_month=end_month, include_org_details=include_org_details) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e) Parameters Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. [optional] include_org_details bool Include usage summaries for each sub-org. [optional] Return type UsageSummaryResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_synthetics UsageSyntheticsResponse get_usage_synthetics(start_hr) Get hourly usage for Synthetics Checks Get hourly usage for Synthetics checks . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageSyntheticsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_synthetics_api UsageSyntheticsAPIResponse get_usage_synthetics_api(start_hr) Get hourly usage for Synthetics API Checks Get hourly usage for synthetics API checks . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageSyntheticsAPIResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_synthetics_browser UsageSyntheticsBrowserResponse get_usage_synthetics_browser(start_hr) Get hourly usage for Synthetics Browser Checks Get hourly usage for synthetics browser checks. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageSyntheticsBrowserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_timeseries UsageTimeseriesResponse get_usage_timeseries(start_hr) Get hourly usage for custom metrics Get hourly usage for custom metrics . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageTimeseriesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_top_avg_metrics UsageTopAvgMetricsResponse get_usage_top_avg_metrics() Get top custom metrics by hourly average Get top custom metrics by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = [ \"names_example\", ] # [str] | Comma-separated list of metric names. (optional) limit = 500 # int | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. (optional) if omitted the server will use the default value of 500 # example passing only required values which don't have defaults set # and optional values try: # Get top custom metrics by hourly average api_response = api_instance.get_usage_top_avg_metrics(month=month, day=day, names=names, limit=limit) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_top_avg_metrics: %s\\n\" % e) Parameters Name Type Description Notes month datetime 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 datetime 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 [str] Comma-separated list of metric names. [optional] limit int Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. [optional] if omitted the server will use the default value of 500 Return type UsageTopAvgMetricsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_usage_trace UsageTraceResponse get_usage_trace(start_hr) Get hourly usage for Trace Search Get hourly usage for trace search. Note This endpoint has been renamed to /api/v1/usage/indexed-spans . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e) Parameters Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] Return type UsageTraceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json;datetime-format=rfc3339 HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.UsageMeteringApi"},{"location":"v1/UsageMeteringApi/#datadog_api_clientv1usagemeteringapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description get_daily_custom_reports GET /api/v1/daily_custom_reports Get the list of available daily custom reports get_incident_management GET /api/v1/usage/incident-management Get hourly usage for incident management get_ingested_spans GET /api/v1/usage/ingested-spans Get hourly usage for ingested spans get_monthly_custom_reports GET /api/v1/monthly_custom_reports Get the list of available monthly custom reports get_specified_daily_custom_reports GET /api/v1/daily_custom_reports/{report_id} Get specified daily custom reports get_specified_monthly_custom_reports GET /api/v1/monthly_custom_reports/{report_id} Get specified monthly custom reports get_tracing_without_limits GET /api/v1/usage/tracing-without-limits Get hourly usage for tracing without limits get_usage_analyzed_logs GET /api/v1/usage/analyzed_logs Get hourly usage for analyzed logs get_usage_attribution GET /api/v1/usage/attribution Get Usage Attribution get_usage_billable_summary GET /api/v1/usage/billable-summary Get billable usage across your account get_usage_compliance_monitoring GET /api/v1/usage/compliance-monitoring Get hourly usage for Compliance Monitoring get_usage_fargate GET /api/v1/usage/fargate Get hourly usage for Fargate get_usage_hosts GET /api/v1/usage/hosts Get hourly usage for hosts and containers get_usage_indexed_spans GET /api/v1/usage/indexed-spans Get hourly usage for indexed spans get_usage_internet_of_things GET /api/v1/usage/iot Get hourly usage for IoT get_usage_lambda GET /api/v1/usage/aws_lambda Get hourly usage for Lambda get_usage_logs GET /api/v1/usage/logs Get hourly usage for Logs get_usage_logs_by_index GET /api/v1/usage/logs_by_index Get hourly usage for Logs by Index get_usage_logs_by_retention GET /api/v1/usage/logs-by-retention Get hourly logs usage by retention get_usage_network_flows GET /api/v1/usage/network_flows Get hourly usage for Network Flows get_usage_network_hosts GET /api/v1/usage/network_hosts Get hourly usage for Network Hosts get_usage_profiling GET /api/v1/usage/profiling Get hourly usage for profiled hosts get_usage_rum_sessions GET /api/v1/usage/rum_sessions Get hourly usage for RUM Sessions get_usage_snmp GET /api/v1/usage/snmp Get hourly usage for SNMP devices get_usage_summary GET /api/v1/usage/summary Get usage across your multi-org account get_usage_synthetics GET /api/v1/usage/synthetics Get hourly usage for Synthetics Checks get_usage_synthetics_api GET /api/v1/usage/synthetics_api Get hourly usage for Synthetics API Checks get_usage_synthetics_browser GET /api/v1/usage/synthetics_browser Get hourly usage for Synthetics Browser Checks get_usage_timeseries GET /api/v1/usage/timeseries Get hourly usage for custom metrics get_usage_top_avg_metrics GET /api/v1/usage/top_avg_metrics Get top custom metrics by hourly average get_usage_trace GET /api/v1/usage/traces Get hourly usage for Trace Search","title":"datadog_api_client.v1.UsageMeteringApi"},{"location":"v1/UsageMeteringApi/#get_daily_custom_reports","text":"UsageCustomReportsResponse get_daily_custom_reports() Get the list of available daily custom reports Get daily custom reports.","title":"get_daily_custom_reports"},{"location":"v1/UsageMeteringApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response. `[default=60]`. (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available daily custom reports api_response = api_instance.get_daily_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_daily_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters","text":"Name Type Description Notes page_size int The number of files to return in the response. `[default=60]`. [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type","text":"UsageCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_incident_management","text":"UsageIncidentManagementResponse get_incident_management(start_hr) Get hourly usage for incident management Get hourly usage for incident management.","title":"get_incident_management"},{"location":"v1/UsageMeteringApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for incident management api_response = api_instance.get_incident_management(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_incident_management: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_1","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_1","text":"UsageIncidentManagementResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_ingested_spans","text":"UsageIngestedSpansResponse get_ingested_spans(start_hr) Get hourly usage for ingested spans Get hourly usage for ingested spans.","title":"get_ingested_spans"},{"location":"v1/UsageMeteringApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for ingested spans api_response = api_instance.get_ingested_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_ingested_spans: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_2","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_2","text":"UsageIngestedSpansResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_monthly_custom_reports","text":"UsageCustomReportsResponse get_monthly_custom_reports() Get the list of available monthly custom reports Get monthly custom reports.","title":"get_monthly_custom_reports"},{"location":"v1/UsageMeteringApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) page_size = 1 # int | The number of files to return in the response `[default=60].` (optional) page_number = 1 # int | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. (optional) sort_dir = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort = UsageSort(\"start_date\") # UsageSort | The field to sort by: `[computed_on, size, start_date, end_date]`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get the list of available monthly custom reports api_response = api_instance.get_monthly_custom_reports(page_size=page_size, page_number=page_number, sort_dir=sort_dir, sort=sort) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_monthly_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_3","text":"Name Type Description Notes page_size int The number of files to return in the response `[default=60].` [optional] page_number int 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] sort UsageSort The field to sort by: `[computed_on, size, start_date, end_date]`. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_3","text":"UsageCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_specified_daily_custom_reports","text":"UsageSpecifiedCustomReportsResponse get_specified_daily_custom_reports(report_id) Get specified daily custom reports Get specified daily custom reports.","title":"get_specified_daily_custom_reports"},{"location":"v1/UsageMeteringApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_daily_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified daily custom reports api_response = api_instance.get_specified_daily_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_daily_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_4","text":"Name Type Description Notes report_id str The specified ID to search results for.","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_4","text":"UsageSpecifiedCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_specified_monthly_custom_reports","text":"UsageSpecifiedCustomReportsResponse get_specified_monthly_custom_reports(report_id) Get specified monthly custom reports Get specified monthly custom reports.","title":"get_specified_monthly_custom_reports"},{"location":"v1/UsageMeteringApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_specified_monthly_custom_reports\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) report_id = \"report_id_example\" # str | The specified ID to search results for. # example passing only required values which don't have defaults set try: # Get specified monthly custom reports api_response = api_instance.get_specified_monthly_custom_reports(report_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_specified_monthly_custom_reports: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_5","text":"Name Type Description Notes report_id str The specified ID to search results for.","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_5","text":"UsageSpecifiedCustomReportsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_tracing_without_limits","text":"UsageTracingWithoutLimitsResponse get_tracing_without_limits(start_hr) Get hourly usage for tracing without limits Get hourly usage for tracing without limits. Note This endpoint has been renamed to /api/v1/usage/ingested-spans .","title":"get_tracing_without_limits"},{"location":"v1/UsageMeteringApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for tracing without limits api_response = api_instance.get_tracing_without_limits(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_6","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_6","text":"UsageTracingWithoutLimitsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_analyzed_logs","text":"UsageAnalyzedLogsResponse get_usage_analyzed_logs(start_hr) Get hourly usage for analyzed logs Get hourly usage for analyzed logs (Security Monitoring).","title":"get_usage_analyzed_logs"},{"location":"v1/UsageMeteringApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for analyzed logs api_response = api_instance.get_usage_analyzed_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_7","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_7","text":"UsageAnalyzedLogsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_attribution","text":"UsageAttributionResponse get_usage_attribution(start_month, fields) Get Usage Attribution Get Usage Attribution.","title":"get_usage_attribution"},{"location":"v1/UsageMeteringApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_usage_attribution\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields = \"fields_example\" # str | The specified field to search results for. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) sort_direction = UsageSortDirection(\"desc\") # UsageSortDirection | The direction to sort by: `[desc, asc]`. (optional) sort_name = UsageAttributionSort(\"custom_timeseries_usage\") # UsageAttributionSort | The field to sort by. (optional) # example passing only required values which don't have defaults set try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get Usage Attribution api_response = api_instance.get_usage_attribution(start_month, fields, end_month=end_month, sort_direction=sort_direction, sort_name=sort_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_attribution: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_8","text":"Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. fields str The specified field to search results for. end_month datetime 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] sort_name UsageAttributionSort The field to sort by. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_8","text":"UsageAttributionResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_billable_summary","text":"UsageBillableSummaryResponse get_usage_billable_summary() Get billable usage across your account Get billable usage across your account.","title":"get_usage_billable_summary"},{"location":"v1/UsageMeteringApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get billable usage across your account api_response = api_instance.get_usage_billable_summary(month=month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_billable_summary: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_9","text":"Name Type Description Notes month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_9","text":"UsageBillableSummaryResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_9","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_compliance_monitoring","text":"UsageComplianceResponse get_usage_compliance_monitoring(start_hr) Get hourly usage for Compliance Monitoring Get hourly usage for Compliance Monitoring.","title":"get_usage_compliance_monitoring"},{"location":"v1/UsageMeteringApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Compliance Monitoring api_response = api_instance.get_usage_compliance_monitoring(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_compliance_monitoring: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_10","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_10","text":"UsageComplianceResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_10","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_fargate","text":"UsageFargateResponse get_usage_fargate(start_hr) Get hourly usage for Fargate Get hourly usage for Fargate .","title":"get_usage_fargate"},{"location":"v1/UsageMeteringApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Fargate api_response = api_instance.get_usage_fargate(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_fargate: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_11","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_11","text":"UsageFargateResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_11","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_hosts","text":"UsageHostsResponse get_usage_hosts(start_hr) Get hourly usage for hosts and containers Get hourly usage for hosts and containers.","title":"get_usage_hosts"},{"location":"v1/UsageMeteringApi/#example_12","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for hosts and containers api_response = api_instance.get_usage_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_hosts: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_12","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_12","text":"UsageHostsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_12","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_12","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_12","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_indexed_spans","text":"UsageIndexedSpansResponse get_usage_indexed_spans(start_hr) Get hourly usage for indexed spans Get hourly usage for indexed spans.","title":"get_usage_indexed_spans"},{"location":"v1/UsageMeteringApi/#example_13","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for indexed spans api_response = api_instance.get_usage_indexed_spans(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_13","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_13","text":"UsageIndexedSpansResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_13","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_13","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_13","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_internet_of_things","text":"UsageIoTResponse get_usage_internet_of_things(start_hr) Get hourly usage for IoT Get hourly usage for IoT.","title":"get_usage_internet_of_things"},{"location":"v1/UsageMeteringApi/#example_14","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for IoT api_response = api_instance.get_usage_internet_of_things(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_14","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_14","text":"UsageIoTResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_14","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_14","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_14","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_lambda","text":"UsageLambdaResponse get_usage_lambda(start_hr) Get hourly usage for Lambda Get hourly usage for lambda.","title":"get_usage_lambda"},{"location":"v1/UsageMeteringApi/#example_15","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Lambda api_response = api_instance.get_usage_lambda(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_lambda: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_15","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_15","text":"UsageLambdaResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_15","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_15","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_15","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_logs","text":"UsageLogsResponse get_usage_logs(start_hr) Get hourly usage for Logs Get hourly usage for logs.","title":"get_usage_logs"},{"location":"v1/UsageMeteringApi/#example_16","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs api_response = api_instance.get_usage_logs(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_16","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_16","text":"UsageLogsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_16","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_16","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_16","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_logs_by_index","text":"UsageLogsByIndexResponse get_usage_logs_by_index(start_hr) Get hourly usage for Logs by Index Get hourly usage for logs by index.","title":"get_usage_logs_by_index"},{"location":"v1/UsageMeteringApi/#example_17","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) index_name = [ \"index_name_example\", ] # [str] | Comma-separated list of log index names. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Logs by Index api_response = api_instance.get_usage_logs_by_index(start_hr, end_hr=end_hr, index_name=index_name) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_17","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] index_name [str] Comma-separated list of log index names. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_17","text":"UsageLogsByIndexResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_17","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_17","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_17","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_logs_by_retention","text":"UsageLogsByRetentionResponse get_usage_logs_by_retention(start_hr) Get hourly logs usage by retention Get hourly usage for indexed logs by retention period.","title":"get_usage_logs_by_retention"},{"location":"v1/UsageMeteringApi/#example_18","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly logs usage by retention api_response = api_instance.get_usage_logs_by_retention(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_logs_by_retention: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_18","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_18","text":"UsageLogsByRetentionResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_18","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_18","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_18","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_network_flows","text":"UsageNetworkFlowsResponse get_usage_network_flows(start_hr) Get hourly usage for Network Flows Get hourly usage for network flows.","title":"get_usage_network_flows"},{"location":"v1/UsageMeteringApi/#example_19","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Flows api_response = api_instance.get_usage_network_flows(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_flows: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_19","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_19","text":"UsageNetworkFlowsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_19","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_19","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_19","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_network_hosts","text":"UsageNetworkHostsResponse get_usage_network_hosts(start_hr) Get hourly usage for Network Hosts Get hourly usage for network hosts.","title":"get_usage_network_hosts"},{"location":"v1/UsageMeteringApi/#example_20","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Network Hosts api_response = api_instance.get_usage_network_hosts(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_20","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_20","text":"UsageNetworkHostsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_20","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_20","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_20","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_profiling","text":"UsageProfilingResponse get_usage_profiling(start_hr) Get hourly usage for profiled hosts Get hourly usage for profiled hosts.","title":"get_usage_profiling"},{"location":"v1/UsageMeteringApi/#example_21","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for profiled hosts api_response = api_instance.get_usage_profiling(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_profiling: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_21","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_21","text":"UsageProfilingResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_21","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_21","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_21","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_rum_sessions","text":"UsageRumSessionsResponse get_usage_rum_sessions(start_hr) Get hourly usage for RUM Sessions Get hourly usage for RUM Sessions.","title":"get_usage_rum_sessions"},{"location":"v1/UsageMeteringApi/#example_22","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) type = \"type_example\" # str | RUM type: `[browser, mobile]`. Defaults to `browser`. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for RUM Sessions api_response = api_instance.get_usage_rum_sessions(start_hr, end_hr=end_hr, type=type) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_22","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional] type str RUM type: `[browser, mobile]`. Defaults to `browser`. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_22","text":"UsageRumSessionsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_22","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_22","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_22","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_snmp","text":"UsageSNMPResponse get_usage_snmp(start_hr) Get hourly usage for SNMP devices Get hourly usage for SNMP devices.","title":"get_usage_snmp"},{"location":"v1/UsageMeteringApi/#example_23","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for SNMP devices api_response = api_instance.get_usage_snmp(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_snmp: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_23","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_23","text":"UsageSNMPResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_23","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_23","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_23","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_summary","text":"UsageSummaryResponse get_usage_summary(start_month) Get usage across your multi-org account Get usage across your multi-org account. You must have the multi-org feature enabled.","title":"get_usage_summary"},{"location":"v1/UsageMeteringApi/#example_24","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. (optional) include_org_details = True # bool | Include usage summaries for each sub-org. (optional) # example passing only required values which don't have defaults set try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get usage across your multi-org account api_response = api_instance.get_usage_summary(start_month, end_month=end_month, include_org_details=include_org_details) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_summary: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_24","text":"Name Type Description Notes start_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. end_month datetime Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. [optional] include_org_details bool Include usage summaries for each sub-org. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_24","text":"UsageSummaryResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_24","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_24","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_24","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_synthetics","text":"UsageSyntheticsResponse get_usage_synthetics(start_hr) Get hourly usage for Synthetics Checks Get hourly usage for Synthetics checks .","title":"get_usage_synthetics"},{"location":"v1/UsageMeteringApi/#example_25","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Checks api_response = api_instance.get_usage_synthetics(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_25","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_25","text":"UsageSyntheticsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_25","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_25","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_25","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_synthetics_api","text":"UsageSyntheticsAPIResponse get_usage_synthetics_api(start_hr) Get hourly usage for Synthetics API Checks Get hourly usage for synthetics API checks .","title":"get_usage_synthetics_api"},{"location":"v1/UsageMeteringApi/#example_26","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics API Checks api_response = api_instance.get_usage_synthetics_api(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_26","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_26","text":"UsageSyntheticsAPIResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_26","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_26","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_26","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_synthetics_browser","text":"UsageSyntheticsBrowserResponse get_usage_synthetics_browser(start_hr) Get hourly usage for Synthetics Browser Checks Get hourly usage for synthetics browser checks.","title":"get_usage_synthetics_browser"},{"location":"v1/UsageMeteringApi/#example_27","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Synthetics Browser Checks api_response = api_instance.get_usage_synthetics_browser(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_27","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_27","text":"UsageSyntheticsBrowserResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_27","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_27","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_27","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_timeseries","text":"UsageTimeseriesResponse get_usage_timeseries(start_hr) Get hourly usage for custom metrics Get hourly usage for custom metrics .","title":"get_usage_timeseries"},{"location":"v1/UsageMeteringApi/#example_28","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for custom metrics api_response = api_instance.get_usage_timeseries(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_timeseries: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_28","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_28","text":"UsageTimeseriesResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_28","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_28","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_28","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_top_avg_metrics","text":"UsageTopAvgMetricsResponse get_usage_top_avg_metrics() Get top custom metrics by hourly average Get top custom metrics by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed.","title":"get_usage_top_avg_metrics"},{"location":"v1/UsageMeteringApi/#example_29","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) month = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | 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 = [ \"names_example\", ] # [str] | Comma-separated list of metric names. (optional) limit = 500 # int | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. (optional) if omitted the server will use the default value of 500 # example passing only required values which don't have defaults set # and optional values try: # Get top custom metrics by hourly average api_response = api_instance.get_usage_top_avg_metrics(month=month, day=day, names=names, limit=limit) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_top_avg_metrics: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_29","text":"Name Type Description Notes month datetime 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 datetime 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 [str] Comma-separated list of metric names. [optional] limit int Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. [optional] if omitted the server will use the default value of 500","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_29","text":"UsageTopAvgMetricsResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_29","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_29","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_29","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMeteringApi/#get_usage_trace","text":"UsageTraceResponse get_usage_trace(start_hr) Get hourly usage for Trace Search Get hourly usage for trace search. Note This endpoint has been renamed to /api/v1/usage/indexed-spans .","title":"get_usage_trace"},{"location":"v1/UsageMeteringApi/#example_30","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import usage_metering_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = usage_metering_api.UsageMeteringApi(api_client) start_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. (optional) # example passing only required values which don't have defaults set try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get hourly usage for Trace Search api_response = api_instance.get_usage_trace(start_hr, end_hr=end_hr) pprint(api_response) except ApiException as e: print(\"Exception when calling UsageMeteringApi->get_usage_trace: %s\\n\" % e)","title":"Example"},{"location":"v1/UsageMeteringApi/#parameters_30","text":"Name Type Description Notes start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]","title":"Parameters"},{"location":"v1/UsageMeteringApi/#return-type_30","text":"UsageTraceResponse","title":"Return type"},{"location":"v1/UsageMeteringApi/#authorization_30","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsageMeteringApi/#http-request-headers_30","text":"Content-Type : Not defined Accept : application/json;datetime-format=rfc3339","title":"HTTP request headers"},{"location":"v1/UsageMeteringApi/#http-response-details_30","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - User is not authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsageMetricCategory/","text":"UsageMetricCategory Contains the metric category. Properties Name Type Description Notes value str Contains the metric category. must be one of [\"standard\", \"custom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageMetricCategory"},{"location":"v1/UsageMetricCategory/#usagemetriccategory","text":"Contains the metric category.","title":"UsageMetricCategory"},{"location":"v1/UsageMetricCategory/#properties","text":"Name Type Description Notes value str Contains the metric category. must be one of [\"standard\", \"custom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkFlowsHour/","text":"UsageNetworkFlowsHour Number of netflow events indexed for each hour for a given organization. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_event_count int Contains the number of netflow events indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkFlowsHour"},{"location":"v1/UsageNetworkFlowsHour/#usagenetworkflowshour","text":"Number of netflow events indexed for each hour for a given organization.","title":"UsageNetworkFlowsHour"},{"location":"v1/UsageNetworkFlowsHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_event_count int Contains the number of netflow events indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkFlowsResponse/","text":"UsageNetworkFlowsResponse Response containing the number of netflow events indexed for each hour for a given organization. Properties Name Type Description Notes usage [UsageNetworkFlowsHour] Get hourly usage for Network Flows. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkFlowsResponse"},{"location":"v1/UsageNetworkFlowsResponse/#usagenetworkflowsresponse","text":"Response containing the number of netflow events indexed for each hour for a given organization.","title":"UsageNetworkFlowsResponse"},{"location":"v1/UsageNetworkFlowsResponse/#properties","text":"Name Type Description Notes usage [UsageNetworkFlowsHour] Get hourly usage for Network Flows. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkHostsHour/","text":"UsageNetworkHostsHour Number of active NPM hosts for each hour for a given organization. Properties Name Type Description Notes host_count int Contains the number of active NPM hosts. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkHostsHour"},{"location":"v1/UsageNetworkHostsHour/#usagenetworkhostshour","text":"Number of active NPM hosts for each hour for a given organization.","title":"UsageNetworkHostsHour"},{"location":"v1/UsageNetworkHostsHour/#properties","text":"Name Type Description Notes host_count int Contains the number of active NPM hosts. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageNetworkHostsResponse/","text":"UsageNetworkHostsResponse Response containing the number of active NPM hosts for each hour for a given organization. Properties Name Type Description Notes usage [UsageNetworkHostsHour] Get hourly usage for NPM hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageNetworkHostsResponse"},{"location":"v1/UsageNetworkHostsResponse/#usagenetworkhostsresponse","text":"Response containing the number of active NPM hosts for each hour for a given organization.","title":"UsageNetworkHostsResponse"},{"location":"v1/UsageNetworkHostsResponse/#properties","text":"Name Type Description Notes usage [UsageNetworkHostsHour] Get hourly usage for NPM hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageProfilingHour/","text":"UsageProfilingHour The number of profiled hosts for each hour for a given organization. Properties Name Type Description Notes avg_container_agent_count int Get average number of container agents for that hour. [optional] host_count int Contains the total number of profiled hosts reporting during a given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageProfilingHour"},{"location":"v1/UsageProfilingHour/#usageprofilinghour","text":"The number of profiled hosts for each hour for a given organization.","title":"UsageProfilingHour"},{"location":"v1/UsageProfilingHour/#properties","text":"Name Type Description Notes avg_container_agent_count int Get average number of container agents for that hour. [optional] host_count int Contains the total number of profiled hosts reporting during a given hour. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageProfilingResponse/","text":"UsageProfilingResponse Response containing the number of profiled hosts for each hour for a given organization. Properties Name Type Description Notes usage [UsageProfilingHour] Get hourly usage for profiled hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageProfilingResponse"},{"location":"v1/UsageProfilingResponse/#usageprofilingresponse","text":"Response containing the number of profiled hosts for each hour for a given organization.","title":"UsageProfilingResponse"},{"location":"v1/UsageProfilingResponse/#properties","text":"Name Type Description Notes usage [UsageProfilingHour] Get hourly usage for profiled hosts. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageReportsType/","text":"UsageReportsType The type of reports. Properties Name Type Description Notes value str The type of reports. defaults to \"reports\", must be one of [\"reports\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageReportsType"},{"location":"v1/UsageReportsType/#usagereportstype","text":"The type of reports.","title":"UsageReportsType"},{"location":"v1/UsageReportsType/#properties","text":"Name Type Description Notes value str The type of reports. defaults to \"reports\", must be one of [\"reports\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageRumSessionsHour/","text":"UsageRumSessionsHour Number of RUM Sessions recorded for each hour for a given organization. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] session_count int Contains the number of RUM Sessions. [optional] session_count_android int Contains the number of mobile RUM Sessions on Android (data available beginning December 1, 2020). [optional] session_count_ios int Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageRumSessionsHour"},{"location":"v1/UsageRumSessionsHour/#usagerumsessionshour","text":"Number of RUM Sessions recorded for each hour for a given organization.","title":"UsageRumSessionsHour"},{"location":"v1/UsageRumSessionsHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] session_count int Contains the number of RUM Sessions. [optional] session_count_android int Contains the number of mobile RUM Sessions on Android (data available beginning December 1, 2020). [optional] session_count_ios int Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageRumSessionsResponse/","text":"UsageRumSessionsResponse Response containing the number of RUM Sessions for each hour for a given organization. Properties Name Type Description Notes usage [UsageRumSessionsHour] Get hourly usage for RUM Sessions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageRumSessionsResponse"},{"location":"v1/UsageRumSessionsResponse/#usagerumsessionsresponse","text":"Response containing the number of RUM Sessions for each hour for a given organization.","title":"UsageRumSessionsResponse"},{"location":"v1/UsageRumSessionsResponse/#properties","text":"Name Type Description Notes usage [UsageRumSessionsHour] Get hourly usage for RUM Sessions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSNMPHour/","text":"UsageSNMPHour The number of SNMP devices for each hour for a given organization. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] snmp_devices int Contains the number of SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSNMPHour"},{"location":"v1/UsageSNMPHour/#usagesnmphour","text":"The number of SNMP devices for each hour for a given organization.","title":"UsageSNMPHour"},{"location":"v1/UsageSNMPHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] snmp_devices int Contains the number of SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSNMPResponse/","text":"UsageSNMPResponse Response containing the number of SNMP devices for each hour for a given organization. Properties Name Type Description Notes usage [UsageSNMPHour] Get hourly usage for SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSNMPResponse"},{"location":"v1/UsageSNMPResponse/#usagesnmpresponse","text":"Response containing the number of SNMP devices for each hour for a given organization.","title":"UsageSNMPResponse"},{"location":"v1/UsageSNMPResponse/#properties","text":"Name Type Description Notes usage [UsageSNMPHour] Get hourly usage for SNMP devices. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSort/","text":"UsageSort The field to sort by. Properties Name Type Description Notes value str The field to sort by. defaults to \"start_date\", must be one of [\"computed_on\", \"size\", \"start_date\", \"end_date\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSort"},{"location":"v1/UsageSort/#usagesort","text":"The field to sort by.","title":"UsageSort"},{"location":"v1/UsageSort/#properties","text":"Name Type Description Notes value str The field to sort by. defaults to \"start_date\", must be one of [\"computed_on\", \"size\", \"start_date\", \"end_date\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSortDirection/","text":"UsageSortDirection The direction to sort by. Properties Name Type Description Notes value str The direction to sort by. defaults to \"desc\", must be one of [\"desc\", \"asc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSortDirection"},{"location":"v1/UsageSortDirection/#usagesortdirection","text":"The direction to sort by.","title":"UsageSortDirection"},{"location":"v1/UsageSortDirection/#properties","text":"Name Type Description Notes value str The direction to sort by. defaults to \"desc\", must be one of [\"desc\", \"asc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsAttributes/","text":"UsageSpecifiedCustomReportsAttributes The response containing attributes for specified custom reports. Properties Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of specified custom report. [optional] location str A downloadable file for the specified custom reporting file. [optional] size int size [optional] start_date str The starting date of specified custom report. [optional] tags [str] A list of tags to apply to specified custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsAttributes"},{"location":"v1/UsageSpecifiedCustomReportsAttributes/#usagespecifiedcustomreportsattributes","text":"The response containing attributes for specified custom reports.","title":"UsageSpecifiedCustomReportsAttributes"},{"location":"v1/UsageSpecifiedCustomReportsAttributes/#properties","text":"Name Type Description Notes computed_on str The date the specified custom report was computed. [optional] end_date str The ending date of specified custom report. [optional] location str A downloadable file for the specified custom reporting file. [optional] size int size [optional] start_date str The starting date of specified custom report. [optional] tags [str] A list of tags to apply to specified custom reports. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsData/","text":"UsageSpecifiedCustomReportsData Response containing date and type for specified custom reports. Properties Name Type Description Notes attributes UsageSpecifiedCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsData"},{"location":"v1/UsageSpecifiedCustomReportsData/#usagespecifiedcustomreportsdata","text":"Response containing date and type for specified custom reports.","title":"UsageSpecifiedCustomReportsData"},{"location":"v1/UsageSpecifiedCustomReportsData/#properties","text":"Name Type Description Notes attributes UsageSpecifiedCustomReportsAttributes [optional] id str The date for specified custom reports. [optional] type UsageReportsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsMeta/","text":"UsageSpecifiedCustomReportsMeta The object containing document metadata. Properties Name Type Description Notes page UsageSpecifiedCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsMeta"},{"location":"v1/UsageSpecifiedCustomReportsMeta/#usagespecifiedcustomreportsmeta","text":"The object containing document metadata.","title":"UsageSpecifiedCustomReportsMeta"},{"location":"v1/UsageSpecifiedCustomReportsMeta/#properties","text":"Name Type Description Notes page UsageSpecifiedCustomReportsPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsPage/","text":"UsageSpecifiedCustomReportsPage The object containing page total count for specified ID. Properties Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsPage"},{"location":"v1/UsageSpecifiedCustomReportsPage/#usagespecifiedcustomreportspage","text":"The object containing page total count for specified ID.","title":"UsageSpecifiedCustomReportsPage"},{"location":"v1/UsageSpecifiedCustomReportsPage/#properties","text":"Name Type Description Notes total_count int Total page count. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSpecifiedCustomReportsResponse/","text":"UsageSpecifiedCustomReportsResponse Returns available specified custom reports. Properties Name Type Description Notes data UsageSpecifiedCustomReportsData [optional] meta UsageSpecifiedCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSpecifiedCustomReportsResponse"},{"location":"v1/UsageSpecifiedCustomReportsResponse/#usagespecifiedcustomreportsresponse","text":"Returns available specified custom reports.","title":"UsageSpecifiedCustomReportsResponse"},{"location":"v1/UsageSpecifiedCustomReportsResponse/#properties","text":"Name Type Description Notes data UsageSpecifiedCustomReportsData [optional] meta UsageSpecifiedCustomReportsMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSummaryDate/","text":"UsageSummaryDate Response with hourly report of all data billed by Datadog all organizations. Properties Name Type Description Notes agent_host_top99p int 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 int Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. [optional] apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. [optional] azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. [optional] billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] compliance_container_count_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of compliance containers over all hours in the current date for all organizations. [optional] compliance_host_count_sum int Shows the sum of compliance hosts over all hours in the current date for all organizations. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for all organizations. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for all organizations. [optional] date datetime The date for the usage. [optional] fargate_tasks_count_avg int Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. [optional] fargate_tasks_count_hwm int Shows the average of all Fargate tasks over all hours in the current date for all organizations. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. [optional] heroku_host_top99p int 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 int 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 int Shows the sum of all log events indexed over all hours in the current date for all organizations. [optional] infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. [optional] ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] iot_device_sum int Shows the sum of all IoT devices over all hours in the current date for all organizations. [optional] iot_device_top99p int Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. [optional] mobile_rum_session_count_android_sum int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for all organizations. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. [optional] opentelemetry_host_top99p int 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 [UsageSummaryDateOrg] Organizations associated with a user. [optional] profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. [optional] rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations [optional] rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. [optional] synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. [optional] synthetics_check_calls_count_sum int 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 int Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. [optional] twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. [optional] vsphere_host_top99p int Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSummaryDate"},{"location":"v1/UsageSummaryDate/#usagesummarydate","text":"Response with hourly report of all data billed by Datadog all organizations.","title":"UsageSummaryDate"},{"location":"v1/UsageSummaryDate/#properties","text":"Name Type Description Notes agent_host_top99p int 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 int Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. [optional] apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. [optional] azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. [optional] billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] compliance_container_count_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of compliance containers over all hours in the current date for all organizations. [optional] compliance_host_count_sum int Shows the sum of compliance hosts over all hours in the current date for all organizations. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for all organizations. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for all organizations. [optional] date datetime The date for the usage. [optional] fargate_tasks_count_avg int Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. [optional] fargate_tasks_count_hwm int Shows the average of all Fargate tasks over all hours in the current date for all organizations. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. [optional] heroku_host_top99p int 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 int 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 int Shows the sum of all log events indexed over all hours in the current date for all organizations. [optional] infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. [optional] ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional] iot_device_sum int Shows the sum of all IoT devices over all hours in the current date for all organizations. [optional] iot_device_top99p int Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. [optional] mobile_rum_session_count_android_sum int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for all organizations. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. [optional] opentelemetry_host_top99p int 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 [UsageSummaryDateOrg] Organizations associated with a user. [optional] profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. [optional] rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations [optional] rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. [optional] synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. [optional] synthetics_check_calls_count_sum int 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 int Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. [optional] twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. [optional] vsphere_host_top99p int Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSummaryDateOrg/","text":"UsageSummaryDateOrg Global hourly report of all data billed by Datadog for a given organization. Properties Name Type Description Notes agent_host_top99p int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. [optional] aws_lambda_func_count int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] azure_app_service_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current date for the given org. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current date for the given org. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for the given org. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for the given org. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for the given org. [optional] fargate_tasks_count_avg int The average task count for Fargate. [optional] fargate_tasks_count_hwm int Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. [optional] heroku_host_top99p int Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. [optional] id str The organization id. [optional] incident_management_monthly_active_users_hwm int 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 int Shows the sum of all log events indexed over all hours in the current date for the given org. [optional] infra_host_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for the given org. [optional] iot_device_top99p_sum int 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 int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. [optional] name str The organization name. [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for the given org. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. [optional] opentelemetry_host_top99p int 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 int Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. [optional] public_id str The organization public id. [optional] rum_session_count_sum int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. [optional] synthetics_browser_check_calls_count_sum int 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 int 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 int 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 int 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 int Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSummaryDateOrg"},{"location":"v1/UsageSummaryDateOrg/#usagesummarydateorg","text":"Global hourly report of all data billed by Datadog for a given organization.","title":"UsageSummaryDateOrg"},{"location":"v1/UsageSummaryDateOrg/#properties","text":"Name Type Description Notes agent_host_top99p int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. [optional] aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. [optional] aws_lambda_func_count int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional] azure_app_service_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current date for the given org. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current date for the given org. [optional] container_avg int Shows the average of all distinct containers over all hours in the current date for the given org. [optional] container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for the given org. [optional] custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for the given org. [optional] fargate_tasks_count_avg int The average task count for Fargate. [optional] fargate_tasks_count_hwm int Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. [optional] gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. [optional] heroku_host_top99p int Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. [optional] id str The organization id. [optional] incident_management_monthly_active_users_hwm int 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 int Shows the sum of all log events indexed over all hours in the current date for the given org. [optional] infra_host_top99p int 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 int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for the given org. [optional] iot_device_top99p_sum int 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 int 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 int 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 int Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. [optional] name str The organization name. [optional] netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for the given org. [optional] npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. [optional] opentelemetry_host_top99p int 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 int Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. [optional] public_id str The organization public id. [optional] rum_session_count_sum int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. [optional] synthetics_browser_check_calls_count_sum int 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 int 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 int 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 int 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 int Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSummaryResponse/","text":"UsageSummaryResponse Response with hourly report of all data billed by Datadog all organizations. Properties Name Type Description Notes agent_host_top99p_sum int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. [optional] aws_host_top99p_sum int Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. [optional] azure_app_service_top99p_sum int Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. [optional] azure_host_top99p_sum int Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. [optional] billable_ingested_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current months for all organizations. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current months for all organizations. [optional] container_avg_sum int Shows the average of all distinct containers over all hours in the current months for all organizations. [optional] container_hwm_sum int Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. [optional] custom_ts_sum int Shows the average number of distinct custom metrics over all hours in the current months for all organizations. [optional] end_date datetime Shows the last date of usage in the current months for all organizations. [optional] fargate_tasks_count_avg_sum int Shows the average of all Fargate tasks over all hours in the current months for all organizations. [optional] fargate_tasks_count_hwm_sum int 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 int Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. [optional] heroku_host_top99p_sum int 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 int 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 int Shows the sum of all log events indexed over all hours in the current months for all organizations. [optional] infra_host_top99p_sum int 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 int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current months for all organizations. [optional] iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. [optional] last_updated datetime 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 int 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 int 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 [optional] mobile_rum_session_count_agg_sum int 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 int 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 int 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 int Shows the sum of all Network flows indexed over all hours in the current months for all organizations. [optional] npm_host_top99p_sum int Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. [optional] opentelemetry_host_top99p_sum int 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 int Shows the average number of profiled containers over all hours in the current months for all organizations. [optional] profiling_host_count_top99p_sum int Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. [optional] rehydrated_indexed_events_agg_sum int 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 int 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 int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. [optional] start_date datetime Shows the first date of usage in the current months for all organizations. [optional] synthetics_browser_check_calls_count_agg_sum int 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 int 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 int 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 int Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. [optional] usage [UsageSummaryDate] An array of objects regarding hourly usage. [optional] vsphere_host_top99p_sum int Shows the 99th percentile of all vSphere hosts over all hours in the current months for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSummaryResponse"},{"location":"v1/UsageSummaryResponse/#usagesummaryresponse","text":"Response with hourly report of all data billed by Datadog all organizations.","title":"UsageSummaryResponse"},{"location":"v1/UsageSummaryResponse/#properties","text":"Name Type Description Notes agent_host_top99p_sum int 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 int 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 int Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. [optional] aws_host_top99p_sum int Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. [optional] aws_lambda_func_count int 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 int Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. [optional] azure_app_service_top99p_sum int Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. [optional] azure_host_top99p_sum int Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. [optional] billable_ingested_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] compliance_container_agg_sum bool, date, datetime, dict, float, int, list, str, none_type Shows the sum of all compliance containers over all hours in the current months for all organizations. [optional] compliance_host_agg_sum int Shows the sum of all compliance hosts over all hours in the current months for all organizations. [optional] container_avg_sum int Shows the average of all distinct containers over all hours in the current months for all organizations. [optional] container_hwm_sum int Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. [optional] custom_ts_sum int Shows the average number of distinct custom metrics over all hours in the current months for all organizations. [optional] end_date datetime Shows the last date of usage in the current months for all organizations. [optional] fargate_tasks_count_avg_sum int Shows the average of all Fargate tasks over all hours in the current months for all organizations. [optional] fargate_tasks_count_hwm_sum int 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 int Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. [optional] heroku_host_top99p_sum int 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 int 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 int Shows the sum of all log events indexed over all hours in the current months for all organizations. [optional] infra_host_top99p_sum int 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 int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional] iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current months for all organizations. [optional] iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. [optional] last_updated datetime 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 int 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 int 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 [optional] mobile_rum_session_count_agg_sum int 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 int 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 int 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 int Shows the sum of all Network flows indexed over all hours in the current months for all organizations. [optional] npm_host_top99p_sum int Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. [optional] opentelemetry_host_top99p_sum int 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 int Shows the average number of profiled containers over all hours in the current months for all organizations. [optional] profiling_host_count_top99p_sum int Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. [optional] rehydrated_indexed_events_agg_sum int 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 int 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 int 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 int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. [optional] start_date datetime Shows the first date of usage in the current months for all organizations. [optional] synthetics_browser_check_calls_count_agg_sum int 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 int 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 int 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 int Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. [optional] usage [UsageSummaryDate] An array of objects regarding hourly usage. [optional] vsphere_host_top99p_sum int Shows the 99th percentile of all vSphere hosts over all hours in the current months for all organizations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsAPIHour/","text":"UsageSyntheticsAPIHour Number of Synthetics API tests run for each hour for a given organization. Properties Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsAPIHour"},{"location":"v1/UsageSyntheticsAPIHour/#usagesyntheticsapihour","text":"Number of Synthetics API tests run for each hour for a given organization.","title":"UsageSyntheticsAPIHour"},{"location":"v1/UsageSyntheticsAPIHour/#properties","text":"Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsAPIResponse/","text":"UsageSyntheticsAPIResponse Response containing the number of Synthetics API tests run for each hour for a given organization. Properties Name Type Description Notes usage [UsageSyntheticsAPIHour] Get hourly usage for Synthetics API tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsAPIResponse"},{"location":"v1/UsageSyntheticsAPIResponse/#usagesyntheticsapiresponse","text":"Response containing the number of Synthetics API tests run for each hour for a given organization.","title":"UsageSyntheticsAPIResponse"},{"location":"v1/UsageSyntheticsAPIResponse/#properties","text":"Name Type Description Notes usage [UsageSyntheticsAPIHour] Get hourly usage for Synthetics API tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsBrowserHour/","text":"UsageSyntheticsBrowserHour Number of Synthetics Browser tests run for each hour for a given organization. Properties Name Type Description Notes browser_check_calls_count int Contains the number of Synthetics Browser tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsBrowserHour"},{"location":"v1/UsageSyntheticsBrowserHour/#usagesyntheticsbrowserhour","text":"Number of Synthetics Browser tests run for each hour for a given organization.","title":"UsageSyntheticsBrowserHour"},{"location":"v1/UsageSyntheticsBrowserHour/#properties","text":"Name Type Description Notes browser_check_calls_count int Contains the number of Synthetics Browser tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsBrowserResponse/","text":"UsageSyntheticsBrowserResponse Response containing the number of Synthetics Browser tests run for each hour for a given organization. Properties Name Type Description Notes usage [UsageSyntheticsBrowserHour] Get hourly usage for Synthetics Browser tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsBrowserResponse"},{"location":"v1/UsageSyntheticsBrowserResponse/#usagesyntheticsbrowserresponse","text":"Response containing the number of Synthetics Browser tests run for each hour for a given organization.","title":"UsageSyntheticsBrowserResponse"},{"location":"v1/UsageSyntheticsBrowserResponse/#properties","text":"Name Type Description Notes usage [UsageSyntheticsBrowserHour] Get hourly usage for Synthetics Browser tests. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsHour/","text":"UsageSyntheticsHour The number of synthetics tests run for each hour for a given organization. Properties Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsHour"},{"location":"v1/UsageSyntheticsHour/#usagesyntheticshour","text":"The number of synthetics tests run for each hour for a given organization.","title":"UsageSyntheticsHour"},{"location":"v1/UsageSyntheticsHour/#properties","text":"Name Type Description Notes check_calls_count int Contains the number of Synthetics API tests run. [optional] hour datetime The hour for the usage. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageSyntheticsResponse/","text":"UsageSyntheticsResponse Response containing the number of Synthetics API tests run for each hour for a given organization. Properties Name Type Description Notes usage [UsageSyntheticsHour] Array with the number of hourly Synthetics test run for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageSyntheticsResponse"},{"location":"v1/UsageSyntheticsResponse/#usagesyntheticsresponse","text":"Response containing the number of Synthetics API tests run for each hour for a given organization.","title":"UsageSyntheticsResponse"},{"location":"v1/UsageSyntheticsResponse/#properties","text":"Name Type Description Notes usage [UsageSyntheticsHour] Array with the number of hourly Synthetics test run for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTimeseriesHour/","text":"UsageTimeseriesHour The hourly usage of timeseries. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] num_custom_input_timeseries int Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). [optional] num_custom_output_timeseries int Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). [optional] num_custom_timeseries int Contains the number of non-aggregation custom metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTimeseriesHour"},{"location":"v1/UsageTimeseriesHour/#usagetimeserieshour","text":"The hourly usage of timeseries.","title":"UsageTimeseriesHour"},{"location":"v1/UsageTimeseriesHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] num_custom_input_timeseries int Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). [optional] num_custom_output_timeseries int Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). [optional] num_custom_timeseries int Contains the number of non-aggregation custom metrics. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTimeseriesResponse/","text":"UsageTimeseriesResponse Response containing hourly usage of timeseries. Properties Name Type Description Notes usage [UsageTimeseriesHour] An array of objects regarding hourly usage of timeseries. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTimeseriesResponse"},{"location":"v1/UsageTimeseriesResponse/#usagetimeseriesresponse","text":"Response containing hourly usage of timeseries.","title":"UsageTimeseriesResponse"},{"location":"v1/UsageTimeseriesResponse/#properties","text":"Name Type Description Notes usage [UsageTimeseriesHour] An array of objects regarding hourly usage of timeseries. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTopAvgMetricsHour/","text":"UsageTopAvgMetricsHour Number of hourly recorded custom metrics for a given organization. Properties Name Type Description Notes avg_metric_hour int Average number of timeseries per hour in which the metric occurs. [optional] max_metric_hour int Maximum number of timeseries per hour in which the metric occurs. [optional] metric_category UsageMetricCategory [optional] metric_name str Contains the custom metric name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTopAvgMetricsHour"},{"location":"v1/UsageTopAvgMetricsHour/#usagetopavgmetricshour","text":"Number of hourly recorded custom metrics for a given organization.","title":"UsageTopAvgMetricsHour"},{"location":"v1/UsageTopAvgMetricsHour/#properties","text":"Name Type Description Notes avg_metric_hour int Average number of timeseries per hour in which the metric occurs. [optional] max_metric_hour int Maximum number of timeseries per hour in which the metric occurs. [optional] metric_category UsageMetricCategory [optional] metric_name str Contains the custom metric name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTopAvgMetricsMetadata/","text":"UsageTopAvgMetricsMetadata The object containing document metadata. Properties Name Type Description Notes day bool, date, datetime, dict, float, int, list, str, none_type The day value from the user request that contains the returned usage data. (If day was used the request) [optional] month bool, date, datetime, dict, float, int, list, str, none_type The month value from the user request that contains the returned usage data. (If month was used the request) [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTopAvgMetricsMetadata"},{"location":"v1/UsageTopAvgMetricsMetadata/#usagetopavgmetricsmetadata","text":"The object containing document metadata.","title":"UsageTopAvgMetricsMetadata"},{"location":"v1/UsageTopAvgMetricsMetadata/#properties","text":"Name Type Description Notes day bool, date, datetime, dict, float, int, list, str, none_type The day value from the user request that contains the returned usage data. (If day was used the request) [optional] month bool, date, datetime, dict, float, int, list, str, none_type The month value from the user request that contains the returned usage data. (If month was used the request) [optional] pagination UsageAttributionPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTopAvgMetricsResponse/","text":"UsageTopAvgMetricsResponse Response containing the number of hourly recorded custom metrics for a given organization. Properties Name Type Description Notes metadata UsageTopAvgMetricsMetadata [optional] usage [UsageTopAvgMetricsHour] Number of hourly recorded custom metrics for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTopAvgMetricsResponse"},{"location":"v1/UsageTopAvgMetricsResponse/#usagetopavgmetricsresponse","text":"Response containing the number of hourly recorded custom metrics for a given organization.","title":"UsageTopAvgMetricsResponse"},{"location":"v1/UsageTopAvgMetricsResponse/#properties","text":"Name Type Description Notes metadata UsageTopAvgMetricsMetadata [optional] usage [UsageTopAvgMetricsHour] Number of hourly recorded custom metrics for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTraceHour/","text":"UsageTraceHour The hours of trace usage. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of Indexed Spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTraceHour"},{"location":"v1/UsageTraceHour/#usagetracehour","text":"The hours of trace usage.","title":"UsageTraceHour"},{"location":"v1/UsageTraceHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] indexed_events_count int Contains the number of Indexed Spans indexed. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTraceResponse/","text":"UsageTraceResponse A response containing trace usage. Properties Name Type Description Notes usage [UsageTraceHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTraceResponse"},{"location":"v1/UsageTraceResponse/#usagetraceresponse","text":"A response containing trace usage.","title":"UsageTraceResponse"},{"location":"v1/UsageTraceResponse/#properties","text":"Name Type Description Notes usage [UsageTraceHour] Array with the number of hourly traces indexed for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTracingWithoutLimitsHour/","text":"UsageTracingWithoutLimitsHour Tracing without limits usage for a given organization for a given hour. Properties Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTracingWithoutLimitsHour"},{"location":"v1/UsageTracingWithoutLimitsHour/#usagetracingwithoutlimitshour","text":"Tracing without limits usage for a given organization for a given hour.","title":"UsageTracingWithoutLimitsHour"},{"location":"v1/UsageTracingWithoutLimitsHour/#properties","text":"Name Type Description Notes hour datetime The hour for the usage. [optional] ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsageTracingWithoutLimitsResponse/","text":"UsageTracingWithoutLimitsResponse Response containing the tracing without limits usage for each hour for a given organization. Properties Name Type Description Notes usage [UsageTracingWithoutLimitsHour] Get hourly usage for tracing without limits. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsageTracingWithoutLimitsResponse"},{"location":"v1/UsageTracingWithoutLimitsResponse/#usagetracingwithoutlimitsresponse","text":"Response containing the tracing without limits usage for each hour for a given organization.","title":"UsageTracingWithoutLimitsResponse"},{"location":"v1/UsageTracingWithoutLimitsResponse/#properties","text":"Name Type Description Notes usage [UsageTracingWithoutLimitsHour] Get hourly usage for tracing without limits. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/User/","text":"User Create, edit, and disable users. Properties Name Type Description Notes access_role AccessRole [optional] disabled bool The new disabled status of the user. [optional] email str The new email of the user. [optional] handle str The user handle, must be a valid email. [optional] icon str Gravatar icon associated to the user. optional name str The name of the user. [optional] verified bool Whether or not the user logged in Datadog at least once. optional [Back to Model list] [Back to API list] [Back to README]","title":"User"},{"location":"v1/User/#user","text":"Create, edit, and disable users.","title":"User"},{"location":"v1/User/#properties","text":"Name Type Description Notes access_role AccessRole [optional] disabled bool The new disabled status of the user. [optional] email str The new email of the user. [optional] handle str The user handle, must be a valid email. [optional] icon str Gravatar icon associated to the user. optional name str The name of the user. [optional] verified bool Whether or not the user logged in Datadog at least once. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UserDisableResponse/","text":"UserDisableResponse Array of user disabled for a given organization. Properties Name Type Description Notes message str Information pertaining to a user disabled for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserDisableResponse"},{"location":"v1/UserDisableResponse/#userdisableresponse","text":"Array of user disabled for a given organization.","title":"UserDisableResponse"},{"location":"v1/UserDisableResponse/#properties","text":"Name Type Description Notes message str Information pertaining to a user disabled for a given organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UserListResponse/","text":"UserListResponse Array of Datadog users for a given organization. Properties Name Type Description Notes users [User] Array of users. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserListResponse"},{"location":"v1/UserListResponse/#userlistresponse","text":"Array of Datadog users for a given organization.","title":"UserListResponse"},{"location":"v1/UserListResponse/#properties","text":"Name Type Description Notes users [User] Array of users. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UserResponse/","text":"UserResponse A Datadog User. Properties Name Type Description Notes user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponse"},{"location":"v1/UserResponse/#userresponse","text":"A Datadog User.","title":"UserResponse"},{"location":"v1/UserResponse/#properties","text":"Name Type Description Notes user User [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/UsersApi/","text":"datadog_api_client.v1.UsersApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v1/user Create a user disable_user DELETE /api/v1/user/{user_handle} Disable a user get_user GET /api/v1/user/{user_handle} Get user details list_users GET /api/v1/user List all users update_user PUT /api/v1/user/{user_handle} Update a user create_user UserResponse create_user(body) Create a user Create a user for your organization. Note : Users can only be created with the admin access role if application keys belong to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | User object that needs to be created. # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e) Parameters Name Type Description Notes body User User object that needs to be created. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 User created - 400 Bad Request - 403 Authentication error - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README] disable_user UserDisableResponse disable_user(user_handle) Disable a user Delete a user from an organization. Note : This endpoint can only be used with application keys belonging to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The handle of the user. # example passing only required values which don't have defaults set try: # Disable a user api_response = api_instance.disable_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e) Parameters Name Type Description Notes user_handle str The handle of the user. Return type UserDisableResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 User disabled - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_user UserResponse get_user(user_handle) Get user details Get a user's details. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e) Parameters Name Type Description Notes user_handle str The ID of the user. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_users UserListResponse list_users() List all users List all users for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) # example, this endpoint has no required or optional parameters try: # List all users api_response = api_instance.list_users() pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type UserListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_user UserResponse update_user(user_handle, body) Update a user Update a user information. Note : It can only be used with application keys belonging to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | Description of the update. # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_handle, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e) Parameters Name Type Description Notes user_handle str The ID of the user. body User Description of the update. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 User updated - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v1.UsersApi"},{"location":"v1/UsersApi/#datadog_api_clientv1usersapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v1/user Create a user disable_user DELETE /api/v1/user/{user_handle} Disable a user get_user GET /api/v1/user/{user_handle} Get user details list_users GET /api/v1/user List all users update_user PUT /api/v1/user/{user_handle} Update a user","title":"datadog_api_client.v1.UsersApi"},{"location":"v1/UsersApi/#create_user","text":"UserResponse create_user(body) Create a user Create a user for your organization. Note : Users can only be created with the admin access role if application keys belong to administrators.","title":"create_user"},{"location":"v1/UsersApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | User object that needs to be created. # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters","text":"Name Type Description Notes body User User object that needs to be created.","title":"Parameters"},{"location":"v1/UsersApi/#return-type","text":"UserResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details","text":"Status code Description Response headers 200 User created - 400 Bad Request - 403 Authentication error - 409 Conflict - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#disable_user","text":"UserDisableResponse disable_user(user_handle) Disable a user Delete a user from an organization. Note : This endpoint can only be used with application keys belonging to administrators.","title":"disable_user"},{"location":"v1/UsersApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The handle of the user. # example passing only required values which don't have defaults set try: # Disable a user api_response = api_instance.disable_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_1","text":"Name Type Description Notes user_handle str The handle of the user.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_1","text":"UserDisableResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_1","text":"Status code Description Response headers 200 User disabled - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#get_user","text":"UserResponse get_user(user_handle) Get user details Get a user's details.","title":"get_user"},{"location":"v1/UsersApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_handle) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_2","text":"Name Type Description Notes user_handle str The ID of the user.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_2","text":"UserResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_2","text":"Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#list_users","text":"UserListResponse list_users() List all users List all users for your organization.","title":"list_users"},{"location":"v1/UsersApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) # example, this endpoint has no required or optional parameters try: # List all users api_response = api_instance.list_users() pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_3","text":"UserListResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/UsersApi/#update_user","text":"UserResponse update_user(user_handle, body) Update a user Update a user information. Note : It can only be used with application keys belonging to administrators.","title":"update_user"},{"location":"v1/UsersApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v1 import ApiClient, ApiException, Configuration from datadog_api_client.v1.api import users_api from datadog_api_client.v1.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_handle = \"test@datadoghq.com\" # str | The ID of the user. body = User( access_role=AccessRole(\"st\"), disabled=False, email=\"test@datadoghq.com\", handle=\"test@datadoghq.com\", icon=\"/path/to/matching/gravatar/icon\", name=\"test user\", verified=True, ) # User | Description of the update. # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_handle, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e)","title":"Example"},{"location":"v1/UsersApi/#parameters_4","text":"Name Type Description Notes user_handle str The ID of the user. body User Description of the update.","title":"Parameters"},{"location":"v1/UsersApi/#return-type_4","text":"UserResponse","title":"Return type"},{"location":"v1/UsersApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v1/UsersApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v1/UsersApi/#http-response-details_4","text":"Status code Description Response headers 200 User updated - 400 Bad Request - 403 Authentication error - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v1/Widget/","text":"Widget Information about widget. Note : The layout property is required for widgets in dashboards with free layout_type . For the new dashboard layout , the layout property depends on the reflow_type of the dashboard. - If reflow_type is fixed , layout is required. - If reflow_type is auto , layout should not be set. Properties Name Type Description Notes definition WidgetDefinition id int ID of the widget. [optional] layout WidgetLayout [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Widget"},{"location":"v1/Widget/#widget","text":"Information about widget. Note : The layout property is required for widgets in dashboards with free layout_type . For the new dashboard layout , the layout property depends on the reflow_type of the dashboard. - If reflow_type is fixed , layout is required. - If reflow_type is auto , layout should not be set.","title":"Widget"},{"location":"v1/Widget/#properties","text":"Name Type Description Notes definition WidgetDefinition id int ID of the widget. [optional] layout WidgetLayout [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetAggregator/","text":"WidgetAggregator Aggregator used for the request. Properties Name Type Description Notes value str Aggregator used for the request. must be one of [\"avg\", \"last\", \"max\", \"min\", \"sum\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetAggregator"},{"location":"v1/WidgetAggregator/#widgetaggregator","text":"Aggregator used for the request.","title":"WidgetAggregator"},{"location":"v1/WidgetAggregator/#properties","text":"Name Type Description Notes value str Aggregator used for the request. must be one of [\"avg\", \"last\", \"max\", \"min\", \"sum\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetAxis/","text":"WidgetAxis Axis controls for the widget. Properties Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"WidgetAxis"},{"location":"v1/WidgetAxis/#widgetaxis","text":"Axis controls for the widget.","title":"WidgetAxis"},{"location":"v1/WidgetAxis/#properties","text":"Name Type Description Notes include_zero bool True includes zero. [optional] label str The label of the axis to display on the graph. [optional] max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of \"auto\" scale str Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). [optional] if omitted the server will use the default value of \"linear\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetChangeType/","text":"WidgetChangeType Show the absolute or the relative change. Properties Name Type Description Notes value str Show the absolute or the relative change. must be one of [\"absolute\", \"relative\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetChangeType"},{"location":"v1/WidgetChangeType/#widgetchangetype","text":"Show the absolute or the relative change.","title":"WidgetChangeType"},{"location":"v1/WidgetChangeType/#properties","text":"Name Type Description Notes value str Show the absolute or the relative change. must be one of [\"absolute\", \"relative\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetColorPreference/","text":"WidgetColorPreference Which color to use on the widget. Properties Name Type Description Notes value str Which color to use on the widget. must be one of [\"background\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetColorPreference"},{"location":"v1/WidgetColorPreference/#widgetcolorpreference","text":"Which color to use on the widget.","title":"WidgetColorPreference"},{"location":"v1/WidgetColorPreference/#properties","text":"Name Type Description Notes value str Which color to use on the widget. must be one of [\"background\", \"text\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetComparator/","text":"WidgetComparator Comparator to apply. Properties Name Type Description Notes value str Comparator to apply. must be one of [\">\", \">=\", \"<\", \"<=\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetComparator"},{"location":"v1/WidgetComparator/#widgetcomparator","text":"Comparator to apply.","title":"WidgetComparator"},{"location":"v1/WidgetComparator/#properties","text":"Name Type Description Notes value str Comparator to apply. must be one of [\">\", \">=\", \"<\", \"<=\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetCompareTo/","text":"WidgetCompareTo Timeframe used for the change comparison. Properties Name Type Description Notes value str Timeframe used for the change comparison. must be one of [\"hour_before\", \"day_before\", \"week_before\", \"month_before\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetCompareTo"},{"location":"v1/WidgetCompareTo/#widgetcompareto","text":"Timeframe used for the change comparison.","title":"WidgetCompareTo"},{"location":"v1/WidgetCompareTo/#properties","text":"Name Type Description Notes value str Timeframe used for the change comparison. must be one of [\"hour_before\", \"day_before\", \"week_before\", \"month_before\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetConditionalFormat/","text":"WidgetConditionalFormat Define a conditional format for the widget. Properties Name Type Description Notes comparator WidgetComparator palette WidgetPalette value float Value for the comparator. custom_bg_color str Color palette to apply to the background, same values available as palette. [optional] custom_fg_color str Color palette to apply to the foreground, same values available as palette. [optional] hide_value bool True hides values. [optional] image_url str Displays an image as the background. [optional] metric str Metric from the request to correlate this conditional format with. [optional] timeframe str Defines the displayed timeframe. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetConditionalFormat"},{"location":"v1/WidgetConditionalFormat/#widgetconditionalformat","text":"Define a conditional format for the widget.","title":"WidgetConditionalFormat"},{"location":"v1/WidgetConditionalFormat/#properties","text":"Name Type Description Notes comparator WidgetComparator palette WidgetPalette value float Value for the comparator. custom_bg_color str Color palette to apply to the background, same values available as palette. [optional] custom_fg_color str Color palette to apply to the foreground, same values available as palette. [optional] hide_value bool True hides values. [optional] image_url str Displays an image as the background. [optional] metric str Metric from the request to correlate this conditional format with. [optional] timeframe str Defines the displayed timeframe. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetCustomLink/","text":"WidgetCustomLink Custom links help you connect a data value to a URL, like a Datadog page or your AWS console. Properties Name Type Description Notes label str The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. link str The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. [Back to Model list] [Back to API list] [Back to README]","title":"WidgetCustomLink"},{"location":"v1/WidgetCustomLink/#widgetcustomlink","text":"Custom links help you connect a data value to a URL, like a Datadog page or your AWS console.","title":"WidgetCustomLink"},{"location":"v1/WidgetCustomLink/#properties","text":"Name Type Description Notes label str The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. link str The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetDefinition/","text":"WidgetDefinition Definition of the widget . Properties Name Type Description Notes time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] unit str Unit to display with the value. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] color str Color of the text. [optional] font_size str Size of the text. [optional] background_color str Background color of the note. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True events [WidgetEvent] List of widget events. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetMonitorSummarySort [optional] color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetServiceSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] autoscale bool Whether to use auto-scaling or not. [optional] custom_unit str Display a unit of your choice on the widget. [optional] color_by_groups [str] List of groups used for colors. [optional] global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] view_mode WidgetViewMode [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] has_search_bar TableWidgetHasSearchBar [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] right_yaxis WidgetAxis [optional] alert_id str ID of the alert to use in the widget. [optional] type ToplistWidgetDefinitionType [optional] viz_type WidgetVizType [optional] requests [ToplistWidgetRequest] List of top list widget requests. [optional] check str Name of the check to use in the widget. [optional] grouping WidgetGrouping [optional] query str Query to filter the monitors with. [optional] text str Text to display. [optional] style HostMapWidgetDefinitionStyle [optional] view GeomapWidgetDefinitionView [optional] layout_type WidgetLayoutType [optional] widgets [Widget] List of widget groups. [optional] url str URL of the image. [optional] content str Content of the note. [optional] view_type str Type of view displayed by the widget. [optional] if omitted the server will use the default value of \"detail\" filters [str] Your environment and primary tag (or * if enabled for your account). [optional] service str APM service. [optional] env str APM environment. [optional] span_name str APM span name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetDefinition"},{"location":"v1/WidgetDefinition/#widgetdefinition","text":"Definition of the widget .","title":"WidgetDefinition"},{"location":"v1/WidgetDefinition/#properties","text":"Name Type Description Notes time WidgetTime [optional] title str Title of your widget. [optional] title_align WidgetTextAlign [optional] title_size str Size of the title. [optional] precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional] text_align WidgetTextAlign [optional] unit str Unit to display with the value. [optional] custom_links [WidgetCustomLink] List of custom links. [optional] group [str] List of tag prefixes to group by. [optional] group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional] tags [str] List of tags used to filter the groups reporting a cluster check. [optional] legend_size str Available legend sizes for a widget. Should be one of \\\"0\\\", \\\"2\\\", \\\"4\\\", \\\"8\\\", \\\"16\\\", or \\\"auto\\\". [optional] markers [WidgetMarker] List of markers. [optional] show_legend bool (screenboard only) Show the legend for this widget. [optional] xaxis WidgetAxis [optional] yaxis WidgetAxis [optional] event_size WidgetEventSize [optional] tags_execution str The execution method for multi-value filters. Can be either and or or. [optional] color str Color of the text. [optional] font_size str Size of the text. [optional] background_color str Background color of the note. [optional] banner_img str URL of image to display as a banner for the group. [optional] show_title bool Whether to show the title or not. [optional] if omitted the server will use the default value of True events [WidgetEvent] List of widget events. [optional] no_group_hosts bool Whether to show the hosts that don\u2019t fit in a group. [optional] no_metric_hosts bool Whether to show the hosts with no metrics. [optional] node_type WidgetNodeType [optional] notes str Notes on the title. [optional] scope [str] List of tags used to filter the map. [optional] has_background bool Whether to display a background or not. [optional] if omitted the server will use the default value of True has_border bool Whether to display a border or not. [optional] if omitted the server will use the default value of True horizontal_align WidgetHorizontalAlign [optional] margin WidgetMargin [optional] sizing WidgetImageSizing [optional] url_dark_theme str URL of the image in dark mode. [optional] vertical_align WidgetVerticalAlign [optional] columns [str] Which columns to display on the widget. [optional] indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional] logset str ID of the log set to use. [optional] message_display WidgetMessageDisplay [optional] show_date_column bool Whether to show the date column or not [optional] show_message_column bool Whether to show the message column or not [optional] sort WidgetMonitorSummarySort [optional] color_preference WidgetColorPreference [optional] count int The number of monitors to display. [optional] display_format WidgetServiceSummaryDisplayFormat [optional] hide_zero_counts bool Whether to show counts of 0 or not. [optional] show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional] start int The start of the list. Typically 0. [optional] summary_type WidgetSummaryType [optional] has_padding bool Whether to add padding or not. [optional] if omitted the server will use the default value of True show_tick bool Whether to show a tick or not. [optional] tick_edge WidgetTickEdge [optional] tick_pos str Where to position the tick on an edge. [optional] autoscale bool Whether to use auto-scaling or not. [optional] custom_unit str Display a unit of your choice on the widget. [optional] color_by_groups [str] List of groups used for colors. [optional] global_time_target str Defined global time target. [optional] show_error_budget bool Defined error budget. [optional] slo_id str ID of the SLO displayed. [optional] time_windows [WidgetTimeWindows] Times being monitored. [optional] view_mode WidgetViewMode [optional] show_breakdown bool Whether to show the latency breakdown or not. [optional] show_distribution bool Whether to show the latency distribution or not. [optional] show_errors bool Whether to show the error metrics or not. [optional] show_hits bool Whether to show the hits metrics or not. [optional] show_latency bool Whether to show the latency metrics or not. [optional] show_resource_list bool Whether to show the resource list or not. [optional] size_format WidgetSizeFormat [optional] has_search_bar TableWidgetHasSearchBar [optional] legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional] legend_layout TimeseriesWidgetLegendLayout [optional] right_yaxis WidgetAxis [optional] alert_id str ID of the alert to use in the widget. [optional] type ToplistWidgetDefinitionType [optional] viz_type WidgetVizType [optional] requests [ToplistWidgetRequest] List of top list widget requests. [optional] check str Name of the check to use in the widget. [optional] grouping WidgetGrouping [optional] query str Query to filter the monitors with. [optional] text str Text to display. [optional] style HostMapWidgetDefinitionStyle [optional] view GeomapWidgetDefinitionView [optional] layout_type WidgetLayoutType [optional] widgets [Widget] List of widget groups. [optional] url str URL of the image. [optional] content str Content of the note. [optional] view_type str Type of view displayed by the widget. [optional] if omitted the server will use the default value of \"detail\" filters [str] Your environment and primary tag (or * if enabled for your account). [optional] service str APM service. [optional] env str APM environment. [optional] span_name str APM span name. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetDisplayType/","text":"WidgetDisplayType Type of display to use for the request. Properties Name Type Description Notes value str Type of display to use for the request. must be one of [\"area\", \"bars\", \"line\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetDisplayType"},{"location":"v1/WidgetDisplayType/#widgetdisplaytype","text":"Type of display to use for the request.","title":"WidgetDisplayType"},{"location":"v1/WidgetDisplayType/#properties","text":"Name Type Description Notes value str Type of display to use for the request. must be one of [\"area\", \"bars\", \"line\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetEvent/","text":"WidgetEvent Event overlay control options. See the dedicated Events JSON schema documentation to learn how to build the . Properties Name Type Description Notes q str Query definition. tags_execution str The execution method for multi-value filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetEvent"},{"location":"v1/WidgetEvent/#widgetevent","text":"Event overlay control options. See the dedicated Events JSON schema documentation to learn how to build the .","title":"WidgetEvent"},{"location":"v1/WidgetEvent/#properties","text":"Name Type Description Notes q str Query definition. tags_execution str The execution method for multi-value filters. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetEventSize/","text":"WidgetEventSize Size to use to display an event. Properties Name Type Description Notes value str Size to use to display an event. must be one of [\"s\", \"l\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetEventSize"},{"location":"v1/WidgetEventSize/#widgeteventsize","text":"Size to use to display an event.","title":"WidgetEventSize"},{"location":"v1/WidgetEventSize/#properties","text":"Name Type Description Notes value str Size to use to display an event. must be one of [\"s\", \"l\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetFieldSort/","text":"WidgetFieldSort Which column and order to sort by Properties Name Type Description Notes column str Facet path for the column order WidgetSort [Back to Model list] [Back to API list] [Back to README]","title":"WidgetFieldSort"},{"location":"v1/WidgetFieldSort/#widgetfieldsort","text":"Which column and order to sort by","title":"WidgetFieldSort"},{"location":"v1/WidgetFieldSort/#properties","text":"Name Type Description Notes column str Facet path for the column order WidgetSort [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetFormula/","text":"WidgetFormula Formula to be used in a widget query. Properties Name Type Description Notes formula str String expression built from queries, formulas, and functions. alias str Expression alias. [optional] limit WidgetFormulaLimit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetFormula"},{"location":"v1/WidgetFormula/#widgetformula","text":"Formula to be used in a widget query.","title":"WidgetFormula"},{"location":"v1/WidgetFormula/#properties","text":"Name Type Description Notes formula str String expression built from queries, formulas, and functions. alias str Expression alias. [optional] limit WidgetFormulaLimit [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetFormulaLimit/","text":"WidgetFormulaLimit Options for limiting results returned. Properties Name Type Description Notes count int Number of results to return. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetFormulaLimit"},{"location":"v1/WidgetFormulaLimit/#widgetformulalimit","text":"Options for limiting results returned.","title":"WidgetFormulaLimit"},{"location":"v1/WidgetFormulaLimit/#properties","text":"Name Type Description Notes count int Number of results to return. [optional] order QuerySortOrder [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetGrouping/","text":"WidgetGrouping The kind of grouping to use. Properties Name Type Description Notes value str The kind of grouping to use. must be one of [\"check\", \"cluster\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetGrouping"},{"location":"v1/WidgetGrouping/#widgetgrouping","text":"The kind of grouping to use.","title":"WidgetGrouping"},{"location":"v1/WidgetGrouping/#properties","text":"Name Type Description Notes value str The kind of grouping to use. must be one of [\"check\", \"cluster\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetHorizontalAlign/","text":"WidgetHorizontalAlign Horizontal alignment. Properties Name Type Description Notes value str Horizontal alignment. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetHorizontalAlign"},{"location":"v1/WidgetHorizontalAlign/#widgethorizontalalign","text":"Horizontal alignment.","title":"WidgetHorizontalAlign"},{"location":"v1/WidgetHorizontalAlign/#properties","text":"Name Type Description Notes value str Horizontal alignment. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetImageSizing/","text":"WidgetImageSizing How to size the image on the widget. The values are based on the image object-fit CSS properties. Note : zoom , fit and center values are deprecated. Properties Name Type Description Notes value str How to size the image on the widget. The values are based on the image `object-fit` CSS properties. Note : `zoom`, `fit` and `center` values are deprecated. must be one of [\"fill\", \"contain\", \"cover\", \"none\", \"scale-down\", \"zoom\", \"fit\", \"center\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetImageSizing"},{"location":"v1/WidgetImageSizing/#widgetimagesizing","text":"How to size the image on the widget. The values are based on the image object-fit CSS properties. Note : zoom , fit and center values are deprecated.","title":"WidgetImageSizing"},{"location":"v1/WidgetImageSizing/#properties","text":"Name Type Description Notes value str How to size the image on the widget. The values are based on the image `object-fit` CSS properties. Note : `zoom`, `fit` and `center` values are deprecated. must be one of [\"fill\", \"contain\", \"cover\", \"none\", \"scale-down\", \"zoom\", \"fit\", \"center\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLayout/","text":"WidgetLayout The layout for a widget on a free or new dashboard layout dashboard. Properties Name Type Description Notes height int The height of the widget. Should be a non-negative integer. width int The width of the widget. Should be a non-negative integer. x int The position of the widget on the x (horizontal) axis. Should be a non-negative integer. y int The position of the widget on the y (vertical) axis. Should be a non-negative integer. is_column_break bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLayout"},{"location":"v1/WidgetLayout/#widgetlayout","text":"The layout for a widget on a free or new dashboard layout dashboard.","title":"WidgetLayout"},{"location":"v1/WidgetLayout/#properties","text":"Name Type Description Notes height int The height of the widget. Should be a non-negative integer. width int The width of the widget. Should be a non-negative integer. x int The position of the widget on the x (horizontal) axis. Should be a non-negative integer. y int The position of the widget on the y (vertical) axis. Should be a non-negative integer. is_column_break bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLayoutType/","text":"WidgetLayoutType Layout type of the group. Properties Name Type Description Notes value str Layout type of the group. defaults to \"ordered\", must be one of [\"ordered\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLayoutType"},{"location":"v1/WidgetLayoutType/#widgetlayouttype","text":"Layout type of the group.","title":"WidgetLayoutType"},{"location":"v1/WidgetLayoutType/#properties","text":"Name Type Description Notes value str Layout type of the group. defaults to \"ordered\", must be one of [\"ordered\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLineType/","text":"WidgetLineType Type of lines displayed. Properties Name Type Description Notes value str Type of lines displayed. must be one of [\"dashed\", \"dotted\", \"solid\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLineType"},{"location":"v1/WidgetLineType/#widgetlinetype","text":"Type of lines displayed.","title":"WidgetLineType"},{"location":"v1/WidgetLineType/#properties","text":"Name Type Description Notes value str Type of lines displayed. must be one of [\"dashed\", \"dotted\", \"solid\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLineWidth/","text":"WidgetLineWidth Width of line displayed. Properties Name Type Description Notes value str Width of line displayed. must be one of [\"normal\", \"thick\", \"thin\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLineWidth"},{"location":"v1/WidgetLineWidth/#widgetlinewidth","text":"Width of line displayed.","title":"WidgetLineWidth"},{"location":"v1/WidgetLineWidth/#properties","text":"Name Type Description Notes value str Width of line displayed. must be one of [\"normal\", \"thick\", \"thin\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetLiveSpan/","text":"WidgetLiveSpan The available timeframes depend on the widget you are using. Properties Name Type Description Notes value str The available timeframes depend on the widget you are using. must be one of [\"1m\", \"5m\", \"10m\", \"15m\", \"30m\", \"1h\", \"4h\", \"1d\", \"2d\", \"1w\", \"1mo\", \"3mo\", \"6mo\", \"1y\", \"alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetLiveSpan"},{"location":"v1/WidgetLiveSpan/#widgetlivespan","text":"The available timeframes depend on the widget you are using.","title":"WidgetLiveSpan"},{"location":"v1/WidgetLiveSpan/#properties","text":"Name Type Description Notes value str The available timeframes depend on the widget you are using. must be one of [\"1m\", \"5m\", \"10m\", \"15m\", \"30m\", \"1h\", \"4h\", \"1d\", \"2d\", \"1w\", \"1mo\", \"3mo\", \"6mo\", \"1y\", \"alert\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMargin/","text":"WidgetMargin Size of the margins around the image. Note : small and large values are deprecated. Properties Name Type Description Notes value str Size of the margins around the image. Note : `small` and `large` values are deprecated. must be one of [\"sm\", \"md\", \"lg\", \"small\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMargin"},{"location":"v1/WidgetMargin/#widgetmargin","text":"Size of the margins around the image. Note : small and large values are deprecated.","title":"WidgetMargin"},{"location":"v1/WidgetMargin/#properties","text":"Name Type Description Notes value str Size of the margins around the image. Note : `small` and `large` values are deprecated. must be one of [\"sm\", \"md\", \"lg\", \"small\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMarker/","text":"WidgetMarker Markers allow you to add visual conditional formatting for your graphs. Properties Name Type Description Notes value str Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. display_type str 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 str Label to display over the marker. [optional] time str Timestamp for the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMarker"},{"location":"v1/WidgetMarker/#widgetmarker","text":"Markers allow you to add visual conditional formatting for your graphs.","title":"WidgetMarker"},{"location":"v1/WidgetMarker/#properties","text":"Name Type Description Notes value str Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. display_type str 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 str Label to display over the marker. [optional] time str Timestamp for the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMessageDisplay/","text":"WidgetMessageDisplay Amount of log lines to display Properties Name Type Description Notes value str Amount of log lines to display must be one of [\"inline\", \"expanded-md\", \"expanded-lg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMessageDisplay"},{"location":"v1/WidgetMessageDisplay/#widgetmessagedisplay","text":"Amount of log lines to display","title":"WidgetMessageDisplay"},{"location":"v1/WidgetMessageDisplay/#properties","text":"Name Type Description Notes value str Amount of log lines to display must be one of [\"inline\", \"expanded-md\", \"expanded-lg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMonitorSummaryDisplayFormat/","text":"WidgetMonitorSummaryDisplayFormat What to display on the widget. Properties Name Type Description Notes value str What to display on the widget. must be one of [\"counts\", \"countsAndList\", \"list\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMonitorSummaryDisplayFormat"},{"location":"v1/WidgetMonitorSummaryDisplayFormat/#widgetmonitorsummarydisplayformat","text":"What to display on the widget.","title":"WidgetMonitorSummaryDisplayFormat"},{"location":"v1/WidgetMonitorSummaryDisplayFormat/#properties","text":"Name Type Description Notes value str What to display on the widget. must be one of [\"counts\", \"countsAndList\", \"list\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetMonitorSummarySort/","text":"WidgetMonitorSummarySort Widget sorting methods. Properties Name Type Description Notes value str Widget sorting methods. must be one of [\"name\", \"group\", \"status\", \"tags\", \"triggered\", \"group,asc\", \"group,desc\", \"name,asc\", \"name,desc\", \"status,asc\", \"status,desc\", \"tags,asc\", \"tags,desc\", \"triggered,asc\", \"triggered,desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetMonitorSummarySort"},{"location":"v1/WidgetMonitorSummarySort/#widgetmonitorsummarysort","text":"Widget sorting methods.","title":"WidgetMonitorSummarySort"},{"location":"v1/WidgetMonitorSummarySort/#properties","text":"Name Type Description Notes value str Widget sorting methods. must be one of [\"name\", \"group\", \"status\", \"tags\", \"triggered\", \"group,asc\", \"group,desc\", \"name,asc\", \"name,desc\", \"status,asc\", \"status,desc\", \"tags,asc\", \"tags,desc\", \"triggered,asc\", \"triggered,desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetNodeType/","text":"WidgetNodeType Which type of node to use in the map. Properties Name Type Description Notes value str Which type of node to use in the map. must be one of [\"host\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetNodeType"},{"location":"v1/WidgetNodeType/#widgetnodetype","text":"Which type of node to use in the map.","title":"WidgetNodeType"},{"location":"v1/WidgetNodeType/#properties","text":"Name Type Description Notes value str Which type of node to use in the map. must be one of [\"host\", \"container\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetOrderBy/","text":"WidgetOrderBy What to order by. Properties Name Type Description Notes value str What to order by. must be one of [\"change\", \"name\", \"present\", \"past\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetOrderBy"},{"location":"v1/WidgetOrderBy/#widgetorderby","text":"What to order by.","title":"WidgetOrderBy"},{"location":"v1/WidgetOrderBy/#properties","text":"Name Type Description Notes value str What to order by. must be one of [\"change\", \"name\", \"present\", \"past\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetPalette/","text":"WidgetPalette Color palette to apply. Properties Name Type Description Notes value str Color palette to apply. must be one of [\"blue\", \"custom_bg\", \"custom_image\", \"custom_text\", \"gray_on_white\", \"grey\", \"green\", \"orange\", \"red\", \"red_on_white\", \"white_on_gray\", \"white_on_green\", \"green_on_white\", \"white_on_red\", \"white_on_yellow\", \"yellow_on_white\", \"black_on_light_yellow\", \"black_on_light_green\", \"black_on_light_red\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetPalette"},{"location":"v1/WidgetPalette/#widgetpalette","text":"Color palette to apply.","title":"WidgetPalette"},{"location":"v1/WidgetPalette/#properties","text":"Name Type Description Notes value str Color palette to apply. must be one of [\"blue\", \"custom_bg\", \"custom_image\", \"custom_text\", \"gray_on_white\", \"grey\", \"green\", \"orange\", \"red\", \"red_on_white\", \"white_on_gray\", \"white_on_green\", \"green_on_white\", \"white_on_red\", \"white_on_yellow\", \"yellow_on_white\", \"black_on_light_yellow\", \"black_on_light_green\", \"black_on_light_red\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetRequestStyle/","text":"WidgetRequestStyle Define request widget style. Properties Name Type Description Notes line_type WidgetLineType [optional] line_width WidgetLineWidth [optional] palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetRequestStyle"},{"location":"v1/WidgetRequestStyle/#widgetrequeststyle","text":"Define request widget style.","title":"WidgetRequestStyle"},{"location":"v1/WidgetRequestStyle/#properties","text":"Name Type Description Notes line_type WidgetLineType [optional] line_width WidgetLineWidth [optional] palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetServiceSummaryDisplayFormat/","text":"WidgetServiceSummaryDisplayFormat Number of columns to display. Properties Name Type Description Notes value str Number of columns to display. must be one of [\"one_column\", \"two_column\", \"three_column\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetServiceSummaryDisplayFormat"},{"location":"v1/WidgetServiceSummaryDisplayFormat/#widgetservicesummarydisplayformat","text":"Number of columns to display.","title":"WidgetServiceSummaryDisplayFormat"},{"location":"v1/WidgetServiceSummaryDisplayFormat/#properties","text":"Name Type Description Notes value str Number of columns to display. must be one of [\"one_column\", \"two_column\", \"three_column\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetSizeFormat/","text":"WidgetSizeFormat Size of the widget. Properties Name Type Description Notes value str Size of the widget. must be one of [\"small\", \"medium\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetSizeFormat"},{"location":"v1/WidgetSizeFormat/#widgetsizeformat","text":"Size of the widget.","title":"WidgetSizeFormat"},{"location":"v1/WidgetSizeFormat/#properties","text":"Name Type Description Notes value str Size of the widget. must be one of [\"small\", \"medium\", \"large\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetSort/","text":"WidgetSort Widget sorting methods. Properties Name Type Description Notes value str Widget sorting methods. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetSort"},{"location":"v1/WidgetSort/#widgetsort","text":"Widget sorting methods.","title":"WidgetSort"},{"location":"v1/WidgetSort/#properties","text":"Name Type Description Notes value str Widget sorting methods. must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetStyle/","text":"WidgetStyle Widget style definition. Properties Name Type Description Notes palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetStyle"},{"location":"v1/WidgetStyle/#widgetstyle","text":"Widget style definition.","title":"WidgetStyle"},{"location":"v1/WidgetStyle/#properties","text":"Name Type Description Notes palette str Color palette to apply to the widget. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetSummaryType/","text":"WidgetSummaryType Which summary type should be used. Properties Name Type Description Notes value str Which summary type should be used. must be one of [\"monitors\", \"groups\", \"combined\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetSummaryType"},{"location":"v1/WidgetSummaryType/#widgetsummarytype","text":"Which summary type should be used.","title":"WidgetSummaryType"},{"location":"v1/WidgetSummaryType/#properties","text":"Name Type Description Notes value str Which summary type should be used. must be one of [\"monitors\", \"groups\", \"combined\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTextAlign/","text":"WidgetTextAlign How to align the text on the widget. Properties Name Type Description Notes value str How to align the text on the widget. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTextAlign"},{"location":"v1/WidgetTextAlign/#widgettextalign","text":"How to align the text on the widget.","title":"WidgetTextAlign"},{"location":"v1/WidgetTextAlign/#properties","text":"Name Type Description Notes value str How to align the text on the widget. must be one of [\"center\", \"left\", \"right\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTickEdge/","text":"WidgetTickEdge Define how you want to align the text on the widget. Properties Name Type Description Notes value str Define how you want to align the text on the widget. must be one of [\"bottom\", \"left\", \"right\", \"top\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTickEdge"},{"location":"v1/WidgetTickEdge/#widgettickedge","text":"Define how you want to align the text on the widget.","title":"WidgetTickEdge"},{"location":"v1/WidgetTickEdge/#properties","text":"Name Type Description Notes value str Define how you want to align the text on the widget. must be one of [\"bottom\", \"left\", \"right\", \"top\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTime/","text":"WidgetTime Time setting for the widget. Properties Name Type Description Notes live_span WidgetLiveSpan [optional] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTime"},{"location":"v1/WidgetTime/#widgettime","text":"Time setting for the widget.","title":"WidgetTime"},{"location":"v1/WidgetTime/#properties","text":"Name Type Description Notes live_span WidgetLiveSpan [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetTimeWindows/","text":"WidgetTimeWindows Define a time window. Properties Name Type Description Notes value str Define a time window. must be one of [\"7d\", \"30d\", \"90d\", \"week_to_date\", \"previous_week\", \"month_to_date\", \"previous_month\", \"global_time\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetTimeWindows"},{"location":"v1/WidgetTimeWindows/#widgettimewindows","text":"Define a time window.","title":"WidgetTimeWindows"},{"location":"v1/WidgetTimeWindows/#properties","text":"Name Type Description Notes value str Define a time window. must be one of [\"7d\", \"30d\", \"90d\", \"week_to_date\", \"previous_week\", \"month_to_date\", \"previous_month\", \"global_time\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetVerticalAlign/","text":"WidgetVerticalAlign Vertical alignment. Properties Name Type Description Notes value str Vertical alignment. must be one of [\"center\", \"top\", \"bottom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetVerticalAlign"},{"location":"v1/WidgetVerticalAlign/#widgetverticalalign","text":"Vertical alignment.","title":"WidgetVerticalAlign"},{"location":"v1/WidgetVerticalAlign/#properties","text":"Name Type Description Notes value str Vertical alignment. must be one of [\"center\", \"top\", \"bottom\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetViewMode/","text":"WidgetViewMode Define how you want the SLO to be displayed. Properties Name Type Description Notes value str Define how you want the SLO to be displayed. must be one of [\"overall\", \"component\", \"both\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetViewMode"},{"location":"v1/WidgetViewMode/#widgetviewmode","text":"Define how you want the SLO to be displayed.","title":"WidgetViewMode"},{"location":"v1/WidgetViewMode/#properties","text":"Name Type Description Notes value str Define how you want the SLO to be displayed. must be one of [\"overall\", \"component\", \"both\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v1/WidgetVizType/","text":"WidgetVizType Whether to display the Alert Graph as a timeseries or a top list. Properties Name Type Description Notes value str Whether to display the Alert Graph as a timeseries or a top list. must be one of [\"timeseries\", \"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"WidgetVizType"},{"location":"v1/WidgetVizType/#widgetviztype","text":"Whether to display the Alert Graph as a timeseries or a top list.","title":"WidgetVizType"},{"location":"v1/WidgetVizType/#properties","text":"Name Type Description Notes value str Whether to display the Alert Graph as a timeseries or a top list. must be one of [\"timeseries\", \"toplist\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/","text":"datadog-api-client.v2 Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/ Requirements. Python >= 3.6 Installation & Usage pip install If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v2 Setuptools Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v2 Getting Started Please follow the installation procedure and then run the following: import time import datadog_api_client.v2 from pprint import pprint from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.model.api_error_response import APIErrorResponse from datadog_api_client.v2.model.dashboard_list_add_items_request import DashboardListAddItemsRequest from datadog_api_client.v2.model.dashboard_list_add_items_response import DashboardListAddItemsResponse from datadog_api_client.v2.model.dashboard_list_delete_items_request import DashboardListDeleteItemsRequest from datadog_api_client.v2.model.dashboard_list_delete_items_response import DashboardListDeleteItemsResponse from datadog_api_client.v2.model.dashboard_list_items import DashboardListItems from datadog_api_client.v2.model.dashboard_list_update_items_request import DashboardListUpdateItemsRequest from datadog_api_client.v2.model.dashboard_list_update_items_response import DashboardListUpdateItemsResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v2.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except datadog_api_client.v2.ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e) Documentation for API Endpoints All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description DashboardListsApi create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List DashboardListsApi delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list DashboardListsApi get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List DashboardListsApi update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list IncidentServicesApi create_incident_service POST /api/v2/services Create a new incident service IncidentServicesApi delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service IncidentServicesApi get_incident_service GET /api/v2/services/{service_id} Get details of an incident service IncidentServicesApi list_incident_services GET /api/v2/services Get a list of all incident services IncidentServicesApi update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service IncidentTeamsApi create_incident_team POST /api/v2/teams Create a new incident team IncidentTeamsApi delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team IncidentTeamsApi get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team IncidentTeamsApi list_incident_teams GET /api/v2/teams Get a list of all incident teams IncidentTeamsApi update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team IncidentsApi create_incident POST /api/v2/incidents Create an incident IncidentsApi delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident IncidentsApi get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident IncidentsApi list_incidents GET /api/v2/incidents Get a list of incidents IncidentsApi update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident KeyManagementApi create_api_key POST /api/v2/api_keys Create an API key KeyManagementApi create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user KeyManagementApi delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key KeyManagementApi delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key KeyManagementApi delete_current_user_application_key DELETE /api/v2/current_user/application_keys/{app_key_id} Delete an application key owned by current user KeyManagementApi get_api_key GET /api/v2/api_keys/{api_key_id} Get API key KeyManagementApi get_current_user_application_key GET /api/v2/current_user/application_keys/{app_key_id} Get one application key owned by current user KeyManagementApi list_api_keys GET /api/v2/api_keys Get all API keys KeyManagementApi list_application_keys GET /api/v2/application_keys Get all application keys KeyManagementApi list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user KeyManagementApi update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key KeyManagementApi update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key KeyManagementApi update_current_user_application_key PATCH /api/v2/current_user/application_keys/{app_key_id} Edit an application key owned by current user LogsApi aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events LogsApi list_logs POST /api/v2/logs/events/search Search logs LogsApi list_logs_get GET /api/v2/logs/events Get a list of logs LogsArchivesApi add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive LogsArchivesApi create_logs_archive POST /api/v2/logs/config/archives Create an archive LogsArchivesApi delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive LogsArchivesApi get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive LogsArchivesApi get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order LogsArchivesApi list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive LogsArchivesApi list_logs_archives GET /api/v2/logs/config/archives Get all archives LogsArchivesApi remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive LogsArchivesApi update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive LogsArchivesApi update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order LogsMetricsApi create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric LogsMetricsApi delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric LogsMetricsApi get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric LogsMetricsApi list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics LogsMetricsApi update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric MetricsApi create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration MetricsApi delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration MetricsApi list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name MetricsApi list_tag_configurations GET /api/v2/metrics List tag configurations MetricsApi list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name MetricsApi list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name MetricsApi update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration ProcessesApi list_processes GET /api/v2/processes Get all processes RolesApi add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role RolesApi add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role RolesApi create_role POST /api/v2/roles Create role RolesApi delete_role DELETE /api/v2/roles/{role_id} Delete role RolesApi get_role GET /api/v2/roles/{role_id} Get a role RolesApi list_permissions GET /api/v2/permissions List permissions RolesApi list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role RolesApi list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role RolesApi list_roles GET /api/v2/roles List roles RolesApi remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission RolesApi remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role RolesApi update_role PATCH /api/v2/roles/{role_id} Update a role SecurityMonitoringApi create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule SecurityMonitoringApi delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule SecurityMonitoringApi get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details SecurityMonitoringApi list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules SecurityMonitoringApi list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals SecurityMonitoringApi search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals SecurityMonitoringApi update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule UsersApi create_user POST /api/v2/users Create a user UsersApi disable_user DELETE /api/v2/users/{user_id} Disable a user UsersApi get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation UsersApi get_user GET /api/v2/users/{user_id} Get user details UsersApi list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization UsersApi list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions UsersApi list_users GET /api/v2/users List all users UsersApi send_invitations POST /api/v2/user_invitations Send invitation emails UsersApi update_user PATCH /api/v2/users/{user_id} Update a user Documentation For Models APIErrorResponse APIKeyCreateAttributes APIKeyCreateData APIKeyCreateRequest APIKeyRelationships APIKeyResponse APIKeyResponseIncludedItem APIKeyUpdateAttributes APIKeyUpdateData APIKeyUpdateRequest APIKeysResponse APIKeysSort APIKeysType ApplicationKeyCreateAttributes ApplicationKeyCreateData ApplicationKeyCreateRequest ApplicationKeyRelationships ApplicationKeyResponse ApplicationKeyResponseIncludedItem ApplicationKeyUpdateAttributes ApplicationKeyUpdateData ApplicationKeyUpdateRequest ApplicationKeysSort ApplicationKeysType Creator DashboardListAddItemsRequest DashboardListAddItemsResponse DashboardListDeleteItemsRequest DashboardListDeleteItemsResponse DashboardListItem DashboardListItemRequest DashboardListItemResponse DashboardListItems DashboardListUpdateItemsRequest DashboardListUpdateItemsResponse DashboardType FullAPIKey FullAPIKeyAttributes FullApplicationKey FullApplicationKeyAttributes IncidentCreateAttributes IncidentCreateData IncidentCreateRelationships IncidentCreateRequest IncidentFieldAttributes IncidentFieldAttributesMultipleValue IncidentFieldAttributesSingleValue IncidentFieldAttributesSingleValueType IncidentFieldAttributesValueType IncidentIntegrationMetadataType IncidentPostmortemType IncidentRelatedObject IncidentResponse IncidentResponseAttributes IncidentResponseData IncidentResponseIncludedItem IncidentResponseRelationships IncidentServiceCreateAttributes IncidentServiceCreateData IncidentServiceCreateRequest IncidentServiceIncludedItems IncidentServiceRelationships IncidentServiceResponse IncidentServiceResponseAttributes IncidentServiceResponseData IncidentServiceType IncidentServiceUpdateAttributes IncidentServiceUpdateData IncidentServiceUpdateRequest IncidentServicesResponse IncidentServicesResponseMeta IncidentServicesResponseMetaPagination IncidentTeamCreateAttributes IncidentTeamCreateData IncidentTeamCreateRequest IncidentTeamIncludedItems IncidentTeamRelationships IncidentTeamResponse IncidentTeamResponseAttributes IncidentTeamResponseData IncidentTeamType IncidentTeamUpdateAttributes IncidentTeamUpdateData IncidentTeamUpdateRequest IncidentTeamsResponse IncidentTimelineCellCreateAttributes IncidentTimelineCellMarkdownContentType IncidentTimelineCellMarkdownCreateAttributes IncidentTimelineCellMarkdownCreateAttributesContent IncidentType IncidentUpdateAttributes IncidentUpdateData IncidentUpdateRelationships IncidentUpdateRequest IncidentsResponse ListApplicationKeysResponse Log LogAttributes LogType LogsAggregateBucket LogsAggregateBucketValue LogsAggregateBucketValueTimeseries LogsAggregateBucketValueTimeseriesPoint LogsAggregateRequest LogsAggregateRequestPage LogsAggregateResponse LogsAggregateResponseData LogsAggregateResponseStatus LogsAggregateSort LogsAggregateSortType LogsAggregationFunction LogsArchive LogsArchiveAttributes LogsArchiveCreateRequest LogsArchiveCreateRequestAttributes LogsArchiveCreateRequestDefinition LogsArchiveCreateRequestDestination LogsArchiveDefinition LogsArchiveDestination LogsArchiveDestinationAzure LogsArchiveDestinationAzureType LogsArchiveDestinationGCS LogsArchiveDestinationGCSType LogsArchiveDestinationS3 LogsArchiveDestinationS3Type LogsArchiveIntegrationAzure LogsArchiveIntegrationGCS LogsArchiveIntegrationS3 LogsArchiveOrder LogsArchiveOrderAttributes LogsArchiveOrderDefinition LogsArchiveOrderDefinitionType LogsArchiveState LogsArchives LogsCompute LogsComputeType LogsGroupBy LogsGroupByHistogram LogsGroupByMissing LogsGroupByTotal LogsListRequest LogsListRequestPage LogsListResponse LogsListResponseLinks LogsMetricCompute LogsMetricComputeAggregationType LogsMetricCreateAttributes LogsMetricCreateData LogsMetricCreateRequest LogsMetricFilter LogsMetricGroupBy LogsMetricResponse LogsMetricResponseAttributes LogsMetricResponseCompute LogsMetricResponseComputeAggregationType LogsMetricResponseData LogsMetricResponseFilter LogsMetricResponseGroupBy LogsMetricType LogsMetricUpdateAttributes LogsMetricUpdateData LogsMetricUpdateRequest LogsMetricsResponse LogsQueryFilter LogsQueryOptions LogsResponseMetadata LogsResponseMetadataPage LogsSort LogsSortOrder LogsWarning Metric MetricAllTags MetricAllTagsAttributes MetricAllTagsResponse MetricDistinctVolume MetricDistinctVolumeAttributes MetricDistinctVolumeType MetricIngestedIndexedVolume MetricIngestedIndexedVolumeAttributes MetricIngestedIndexedVolumeType MetricTagConfiguration MetricTagConfigurationAttributes MetricTagConfigurationCreateAttributes MetricTagConfigurationCreateData MetricTagConfigurationCreateRequest MetricTagConfigurationMetricTypes MetricTagConfigurationResponse MetricTagConfigurationType MetricTagConfigurationUpdateAttributes MetricTagConfigurationUpdateData MetricTagConfigurationUpdateRequest MetricType MetricVolumes MetricVolumesResponse MetricsAndMetricTagConfigurations MetricsAndMetricTagConfigurationsResponse Organization OrganizationAttributes OrganizationsType Pagination PartialAPIKey PartialAPIKeyAttributes PartialApplicationKey PartialApplicationKeyAttributes Permission PermissionAttributes PermissionsResponse PermissionsType ProcessSummariesMeta ProcessSummariesMetaPage ProcessSummariesResponse ProcessSummary ProcessSummaryAttributes ProcessSummaryType QuerySortOrder RelationshipToIncidentIntegrationMetadataData RelationshipToIncidentIntegrationMetadatas RelationshipToIncidentPostmortem RelationshipToIncidentPostmortemData RelationshipToOrganization RelationshipToOrganizationData RelationshipToOrganizations RelationshipToPermission RelationshipToPermissionData RelationshipToPermissions RelationshipToRole RelationshipToRoleData RelationshipToRoles RelationshipToUser RelationshipToUserData RelationshipToUsers ResponseMetaAttributes Role RoleAttributes RoleCreateAttributes RoleCreateData RoleCreateRequest RoleCreateResponse RoleCreateResponseData RoleRelationships RoleResponse RoleResponseRelationships RoleUpdateAttributes RoleUpdateData RoleUpdateRequest RoleUpdateResponse RoleUpdateResponseData RolesResponse RolesSort RolesType SecurityMonitoringFilter SecurityMonitoringFilterAction SecurityMonitoringListRulesResponse SecurityMonitoringRuleCase SecurityMonitoringRuleCaseCreate SecurityMonitoringRuleCreatePayload SecurityMonitoringRuleDetectionMethod SecurityMonitoringRuleEvaluationWindow SecurityMonitoringRuleKeepAlive SecurityMonitoringRuleMaxSignalDuration SecurityMonitoringRuleNewValueOptions SecurityMonitoringRuleNewValueOptionsForgetAfter SecurityMonitoringRuleNewValueOptionsLearningDuration SecurityMonitoringRuleOptions SecurityMonitoringRuleQuery SecurityMonitoringRuleQueryAggregation SecurityMonitoringRuleQueryCreate SecurityMonitoringRuleResponse SecurityMonitoringRuleSeverity SecurityMonitoringRuleUpdatePayload SecurityMonitoringRuntimeAgentRule SecurityMonitoringSignal SecurityMonitoringSignalAttributes SecurityMonitoringSignalListRequest SecurityMonitoringSignalListRequestFilter SecurityMonitoringSignalListRequestPage SecurityMonitoringSignalType SecurityMonitoringSignalsListResponse SecurityMonitoringSignalsListResponseLinks SecurityMonitoringSignalsListResponseMeta SecurityMonitoringSignalsListResponseMetaPage SecurityMonitoringSignalsSort User UserAttributes UserCreateAttributes UserCreateData UserCreateRequest UserInvitationData UserInvitationDataAttributes UserInvitationRelationships UserInvitationResponse UserInvitationResponseData UserInvitationsRequest UserInvitationsResponse UserInvitationsType UserRelationships UserResponse UserResponseIncludedItem UserResponseRelationships UserUpdateAttributes UserUpdateData UserUpdateRequest UsersResponse UsersType Documentation For Authorization 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 Author support@datadoghq.com Notes for Large OpenAPI documents If the OpenAPI document is large, imports in datadog_api_client.v2.apis and datadog_api_client.v2.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v2.api.default_api import DefaultApi - from datadog_api_client.v2.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v2 from datadog_api_client.v2.apis import * from datadog_api_client.v2.models import *","title":"datadog-api-client.v2"},{"location":"v2/#datadog-api-clientv2","text":"Collection of all Datadog Public endpoints. This Python package is automatically generated by the OpenAPI Generator project: API version: 1.0 Package version: 0.1.0 Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.datadoghq.com/support/","title":"datadog-api-client.v2"},{"location":"v2/#requirements","text":"Python >= 3.6","title":"Requirements."},{"location":"v2/#installation-usage","text":"","title":"Installation & Usage"},{"location":"v2/#pip-install","text":"If the python package is hosted on a repository, you can install directly using: pip install git+https://github.com/DataDog/datadog-api-client-python.git (you may need to run pip with root permission: sudo pip install git+https://github.com/DataDog/datadog-api-client-python.git ) Then import the package: import datadog_api_client.v2","title":"pip install"},{"location":"v2/#setuptools","text":"Install via Setuptools . python setup.py install --user (or sudo python setup.py install to install the package for all users) Then import the package: import datadog_api_client.v2","title":"Setuptools"},{"location":"v2/#getting-started","text":"Please follow the installation procedure and then run the following: import time import datadog_api_client.v2 from pprint import pprint from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.model.api_error_response import APIErrorResponse from datadog_api_client.v2.model.dashboard_list_add_items_request import DashboardListAddItemsRequest from datadog_api_client.v2.model.dashboard_list_add_items_response import DashboardListAddItemsResponse from datadog_api_client.v2.model.dashboard_list_delete_items_request import DashboardListDeleteItemsRequest from datadog_api_client.v2.model.dashboard_list_delete_items_response import DashboardListDeleteItemsResponse from datadog_api_client.v2.model.dashboard_list_items import DashboardListItems from datadog_api_client.v2.model.dashboard_list_update_items_request import DashboardListUpdateItemsRequest from datadog_api_client.v2.model.dashboard_list_update_items_response import DashboardListUpdateItemsResponse # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with datadog_api_client.v2.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except datadog_api_client.v2.ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e)","title":"Getting Started"},{"location":"v2/#documentation-for-api-endpoints","text":"All URIs are relative to https://api.datadoghq.com Class Method HTTP request Description DashboardListsApi create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List DashboardListsApi delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list DashboardListsApi get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List DashboardListsApi update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list IncidentServicesApi create_incident_service POST /api/v2/services Create a new incident service IncidentServicesApi delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service IncidentServicesApi get_incident_service GET /api/v2/services/{service_id} Get details of an incident service IncidentServicesApi list_incident_services GET /api/v2/services Get a list of all incident services IncidentServicesApi update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service IncidentTeamsApi create_incident_team POST /api/v2/teams Create a new incident team IncidentTeamsApi delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team IncidentTeamsApi get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team IncidentTeamsApi list_incident_teams GET /api/v2/teams Get a list of all incident teams IncidentTeamsApi update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team IncidentsApi create_incident POST /api/v2/incidents Create an incident IncidentsApi delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident IncidentsApi get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident IncidentsApi list_incidents GET /api/v2/incidents Get a list of incidents IncidentsApi update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident KeyManagementApi create_api_key POST /api/v2/api_keys Create an API key KeyManagementApi create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user KeyManagementApi delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key KeyManagementApi delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key KeyManagementApi delete_current_user_application_key DELETE /api/v2/current_user/application_keys/{app_key_id} Delete an application key owned by current user KeyManagementApi get_api_key GET /api/v2/api_keys/{api_key_id} Get API key KeyManagementApi get_current_user_application_key GET /api/v2/current_user/application_keys/{app_key_id} Get one application key owned by current user KeyManagementApi list_api_keys GET /api/v2/api_keys Get all API keys KeyManagementApi list_application_keys GET /api/v2/application_keys Get all application keys KeyManagementApi list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user KeyManagementApi update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key KeyManagementApi update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key KeyManagementApi update_current_user_application_key PATCH /api/v2/current_user/application_keys/{app_key_id} Edit an application key owned by current user LogsApi aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events LogsApi list_logs POST /api/v2/logs/events/search Search logs LogsApi list_logs_get GET /api/v2/logs/events Get a list of logs LogsArchivesApi add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive LogsArchivesApi create_logs_archive POST /api/v2/logs/config/archives Create an archive LogsArchivesApi delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive LogsArchivesApi get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive LogsArchivesApi get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order LogsArchivesApi list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive LogsArchivesApi list_logs_archives GET /api/v2/logs/config/archives Get all archives LogsArchivesApi remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive LogsArchivesApi update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive LogsArchivesApi update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order LogsMetricsApi create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric LogsMetricsApi delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric LogsMetricsApi get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric LogsMetricsApi list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics LogsMetricsApi update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric MetricsApi create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration MetricsApi delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration MetricsApi list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name MetricsApi list_tag_configurations GET /api/v2/metrics List tag configurations MetricsApi list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name MetricsApi list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name MetricsApi update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration ProcessesApi list_processes GET /api/v2/processes Get all processes RolesApi add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role RolesApi add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role RolesApi create_role POST /api/v2/roles Create role RolesApi delete_role DELETE /api/v2/roles/{role_id} Delete role RolesApi get_role GET /api/v2/roles/{role_id} Get a role RolesApi list_permissions GET /api/v2/permissions List permissions RolesApi list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role RolesApi list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role RolesApi list_roles GET /api/v2/roles List roles RolesApi remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission RolesApi remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role RolesApi update_role PATCH /api/v2/roles/{role_id} Update a role SecurityMonitoringApi create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule SecurityMonitoringApi delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule SecurityMonitoringApi get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details SecurityMonitoringApi list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules SecurityMonitoringApi list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals SecurityMonitoringApi search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals SecurityMonitoringApi update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule UsersApi create_user POST /api/v2/users Create a user UsersApi disable_user DELETE /api/v2/users/{user_id} Disable a user UsersApi get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation UsersApi get_user GET /api/v2/users/{user_id} Get user details UsersApi list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization UsersApi list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions UsersApi list_users GET /api/v2/users List all users UsersApi send_invitations POST /api/v2/user_invitations Send invitation emails UsersApi update_user PATCH /api/v2/users/{user_id} Update a user","title":"Documentation for API Endpoints"},{"location":"v2/#documentation-for-models","text":"APIErrorResponse APIKeyCreateAttributes APIKeyCreateData APIKeyCreateRequest APIKeyRelationships APIKeyResponse APIKeyResponseIncludedItem APIKeyUpdateAttributes APIKeyUpdateData APIKeyUpdateRequest APIKeysResponse APIKeysSort APIKeysType ApplicationKeyCreateAttributes ApplicationKeyCreateData ApplicationKeyCreateRequest ApplicationKeyRelationships ApplicationKeyResponse ApplicationKeyResponseIncludedItem ApplicationKeyUpdateAttributes ApplicationKeyUpdateData ApplicationKeyUpdateRequest ApplicationKeysSort ApplicationKeysType Creator DashboardListAddItemsRequest DashboardListAddItemsResponse DashboardListDeleteItemsRequest DashboardListDeleteItemsResponse DashboardListItem DashboardListItemRequest DashboardListItemResponse DashboardListItems DashboardListUpdateItemsRequest DashboardListUpdateItemsResponse DashboardType FullAPIKey FullAPIKeyAttributes FullApplicationKey FullApplicationKeyAttributes IncidentCreateAttributes IncidentCreateData IncidentCreateRelationships IncidentCreateRequest IncidentFieldAttributes IncidentFieldAttributesMultipleValue IncidentFieldAttributesSingleValue IncidentFieldAttributesSingleValueType IncidentFieldAttributesValueType IncidentIntegrationMetadataType IncidentPostmortemType IncidentRelatedObject IncidentResponse IncidentResponseAttributes IncidentResponseData IncidentResponseIncludedItem IncidentResponseRelationships IncidentServiceCreateAttributes IncidentServiceCreateData IncidentServiceCreateRequest IncidentServiceIncludedItems IncidentServiceRelationships IncidentServiceResponse IncidentServiceResponseAttributes IncidentServiceResponseData IncidentServiceType IncidentServiceUpdateAttributes IncidentServiceUpdateData IncidentServiceUpdateRequest IncidentServicesResponse IncidentServicesResponseMeta IncidentServicesResponseMetaPagination IncidentTeamCreateAttributes IncidentTeamCreateData IncidentTeamCreateRequest IncidentTeamIncludedItems IncidentTeamRelationships IncidentTeamResponse IncidentTeamResponseAttributes IncidentTeamResponseData IncidentTeamType IncidentTeamUpdateAttributes IncidentTeamUpdateData IncidentTeamUpdateRequest IncidentTeamsResponse IncidentTimelineCellCreateAttributes IncidentTimelineCellMarkdownContentType IncidentTimelineCellMarkdownCreateAttributes IncidentTimelineCellMarkdownCreateAttributesContent IncidentType IncidentUpdateAttributes IncidentUpdateData IncidentUpdateRelationships IncidentUpdateRequest IncidentsResponse ListApplicationKeysResponse Log LogAttributes LogType LogsAggregateBucket LogsAggregateBucketValue LogsAggregateBucketValueTimeseries LogsAggregateBucketValueTimeseriesPoint LogsAggregateRequest LogsAggregateRequestPage LogsAggregateResponse LogsAggregateResponseData LogsAggregateResponseStatus LogsAggregateSort LogsAggregateSortType LogsAggregationFunction LogsArchive LogsArchiveAttributes LogsArchiveCreateRequest LogsArchiveCreateRequestAttributes LogsArchiveCreateRequestDefinition LogsArchiveCreateRequestDestination LogsArchiveDefinition LogsArchiveDestination LogsArchiveDestinationAzure LogsArchiveDestinationAzureType LogsArchiveDestinationGCS LogsArchiveDestinationGCSType LogsArchiveDestinationS3 LogsArchiveDestinationS3Type LogsArchiveIntegrationAzure LogsArchiveIntegrationGCS LogsArchiveIntegrationS3 LogsArchiveOrder LogsArchiveOrderAttributes LogsArchiveOrderDefinition LogsArchiveOrderDefinitionType LogsArchiveState LogsArchives LogsCompute LogsComputeType LogsGroupBy LogsGroupByHistogram LogsGroupByMissing LogsGroupByTotal LogsListRequest LogsListRequestPage LogsListResponse LogsListResponseLinks LogsMetricCompute LogsMetricComputeAggregationType LogsMetricCreateAttributes LogsMetricCreateData LogsMetricCreateRequest LogsMetricFilter LogsMetricGroupBy LogsMetricResponse LogsMetricResponseAttributes LogsMetricResponseCompute LogsMetricResponseComputeAggregationType LogsMetricResponseData LogsMetricResponseFilter LogsMetricResponseGroupBy LogsMetricType LogsMetricUpdateAttributes LogsMetricUpdateData LogsMetricUpdateRequest LogsMetricsResponse LogsQueryFilter LogsQueryOptions LogsResponseMetadata LogsResponseMetadataPage LogsSort LogsSortOrder LogsWarning Metric MetricAllTags MetricAllTagsAttributes MetricAllTagsResponse MetricDistinctVolume MetricDistinctVolumeAttributes MetricDistinctVolumeType MetricIngestedIndexedVolume MetricIngestedIndexedVolumeAttributes MetricIngestedIndexedVolumeType MetricTagConfiguration MetricTagConfigurationAttributes MetricTagConfigurationCreateAttributes MetricTagConfigurationCreateData MetricTagConfigurationCreateRequest MetricTagConfigurationMetricTypes MetricTagConfigurationResponse MetricTagConfigurationType MetricTagConfigurationUpdateAttributes MetricTagConfigurationUpdateData MetricTagConfigurationUpdateRequest MetricType MetricVolumes MetricVolumesResponse MetricsAndMetricTagConfigurations MetricsAndMetricTagConfigurationsResponse Organization OrganizationAttributes OrganizationsType Pagination PartialAPIKey PartialAPIKeyAttributes PartialApplicationKey PartialApplicationKeyAttributes Permission PermissionAttributes PermissionsResponse PermissionsType ProcessSummariesMeta ProcessSummariesMetaPage ProcessSummariesResponse ProcessSummary ProcessSummaryAttributes ProcessSummaryType QuerySortOrder RelationshipToIncidentIntegrationMetadataData RelationshipToIncidentIntegrationMetadatas RelationshipToIncidentPostmortem RelationshipToIncidentPostmortemData RelationshipToOrganization RelationshipToOrganizationData RelationshipToOrganizations RelationshipToPermission RelationshipToPermissionData RelationshipToPermissions RelationshipToRole RelationshipToRoleData RelationshipToRoles RelationshipToUser RelationshipToUserData RelationshipToUsers ResponseMetaAttributes Role RoleAttributes RoleCreateAttributes RoleCreateData RoleCreateRequest RoleCreateResponse RoleCreateResponseData RoleRelationships RoleResponse RoleResponseRelationships RoleUpdateAttributes RoleUpdateData RoleUpdateRequest RoleUpdateResponse RoleUpdateResponseData RolesResponse RolesSort RolesType SecurityMonitoringFilter SecurityMonitoringFilterAction SecurityMonitoringListRulesResponse SecurityMonitoringRuleCase SecurityMonitoringRuleCaseCreate SecurityMonitoringRuleCreatePayload SecurityMonitoringRuleDetectionMethod SecurityMonitoringRuleEvaluationWindow SecurityMonitoringRuleKeepAlive SecurityMonitoringRuleMaxSignalDuration SecurityMonitoringRuleNewValueOptions SecurityMonitoringRuleNewValueOptionsForgetAfter SecurityMonitoringRuleNewValueOptionsLearningDuration SecurityMonitoringRuleOptions SecurityMonitoringRuleQuery SecurityMonitoringRuleQueryAggregation SecurityMonitoringRuleQueryCreate SecurityMonitoringRuleResponse SecurityMonitoringRuleSeverity SecurityMonitoringRuleUpdatePayload SecurityMonitoringRuntimeAgentRule SecurityMonitoringSignal SecurityMonitoringSignalAttributes SecurityMonitoringSignalListRequest SecurityMonitoringSignalListRequestFilter SecurityMonitoringSignalListRequestPage SecurityMonitoringSignalType SecurityMonitoringSignalsListResponse SecurityMonitoringSignalsListResponseLinks SecurityMonitoringSignalsListResponseMeta SecurityMonitoringSignalsListResponseMetaPage SecurityMonitoringSignalsSort User UserAttributes UserCreateAttributes UserCreateData UserCreateRequest UserInvitationData UserInvitationDataAttributes UserInvitationRelationships UserInvitationResponse UserInvitationResponseData UserInvitationsRequest UserInvitationsResponse UserInvitationsType UserRelationships UserResponse UserResponseIncludedItem UserResponseRelationships UserUpdateAttributes UserUpdateData UserUpdateRequest UsersResponse UsersType","title":"Documentation For Models"},{"location":"v2/#documentation-for-authorization","text":"","title":"Documentation For Authorization"},{"location":"v2/#apikeyauth","text":"Type : API key API key parameter name : DD-API-KEY Location : HTTP header","title":"apiKeyAuth"},{"location":"v2/#appkeyauth","text":"Type : API key API key parameter name : DD-APPLICATION-KEY Location : HTTP header","title":"appKeyAuth"},{"location":"v2/#author","text":"support@datadoghq.com","title":"Author"},{"location":"v2/#notes-for-large-openapi-documents","text":"If the OpenAPI document is large, imports in datadog_api_client.v2.apis and datadog_api_client.v2.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: Solution 1: Use specific imports for apis and models like: - from datadog_api_client.v2.api.default_api import DefaultApi - from datadog_api_client.v2.model.pet import Pet Solution 2: Before importing the package, adjust the maximum recursion limit as shown below: import sys sys.setrecursionlimit(1500) import datadog_api_client.v2 from datadog_api_client.v2.apis import * from datadog_api_client.v2.models import *","title":"Notes for Large OpenAPI documents"},{"location":"v2/APIErrorResponse/","text":"APIErrorResponse API error response. Properties Name Type Description Notes errors [str] A list of errors. [Back to Model list] [Back to API list] [Back to README]","title":"APIErrorResponse"},{"location":"v2/APIErrorResponse/#apierrorresponse","text":"API error response.","title":"APIErrorResponse"},{"location":"v2/APIErrorResponse/#properties","text":"Name Type Description Notes errors [str] A list of errors. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyCreateAttributes/","text":"APIKeyCreateAttributes Attributes used to create an API Key. Properties Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyCreateAttributes"},{"location":"v2/APIKeyCreateAttributes/#apikeycreateattributes","text":"Attributes used to create an API Key.","title":"APIKeyCreateAttributes"},{"location":"v2/APIKeyCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyCreateData/","text":"APIKeyCreateData Object used to create an API key. Properties Name Type Description Notes attributes APIKeyCreateAttributes type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyCreateData"},{"location":"v2/APIKeyCreateData/#apikeycreatedata","text":"Object used to create an API key.","title":"APIKeyCreateData"},{"location":"v2/APIKeyCreateData/#properties","text":"Name Type Description Notes attributes APIKeyCreateAttributes type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyCreateRequest/","text":"APIKeyCreateRequest Request used to create an API key. Properties Name Type Description Notes data APIKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyCreateRequest"},{"location":"v2/APIKeyCreateRequest/#apikeycreaterequest","text":"Request used to create an API key.","title":"APIKeyCreateRequest"},{"location":"v2/APIKeyCreateRequest/#properties","text":"Name Type Description Notes data APIKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyRelationships/","text":"APIKeyRelationships Resources related to the API key. Properties Name Type Description Notes created_by RelationshipToUser [optional] modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyRelationships"},{"location":"v2/APIKeyRelationships/#apikeyrelationships","text":"Resources related to the API key.","title":"APIKeyRelationships"},{"location":"v2/APIKeyRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyResponse/","text":"APIKeyResponse Response for retrieving an API key. Properties Name Type Description Notes data FullAPIKey [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyResponse"},{"location":"v2/APIKeyResponse/#apikeyresponse","text":"Response for retrieving an API key.","title":"APIKeyResponse"},{"location":"v2/APIKeyResponse/#properties","text":"Name Type Description Notes data FullAPIKey [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyResponseIncludedItem/","text":"APIKeyResponseIncludedItem An object related to an API key. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyResponseIncludedItem"},{"location":"v2/APIKeyResponseIncludedItem/#apikeyresponseincludeditem","text":"An object related to an API key.","title":"APIKeyResponseIncludedItem"},{"location":"v2/APIKeyResponseIncludedItem/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyUpdateAttributes/","text":"APIKeyUpdateAttributes Attributes used to update an API Key. Properties Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyUpdateAttributes"},{"location":"v2/APIKeyUpdateAttributes/#apikeyupdateattributes","text":"Attributes used to update an API Key.","title":"APIKeyUpdateAttributes"},{"location":"v2/APIKeyUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the API key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyUpdateData/","text":"APIKeyUpdateData Object used to update an API key. Properties Name Type Description Notes attributes APIKeyUpdateAttributes id str ID of the API key. type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyUpdateData"},{"location":"v2/APIKeyUpdateData/#apikeyupdatedata","text":"Object used to update an API key.","title":"APIKeyUpdateData"},{"location":"v2/APIKeyUpdateData/#properties","text":"Name Type Description Notes attributes APIKeyUpdateAttributes id str ID of the API key. type APIKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeyUpdateRequest/","text":"APIKeyUpdateRequest Request used to update an API key. Properties Name Type Description Notes data APIKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"APIKeyUpdateRequest"},{"location":"v2/APIKeyUpdateRequest/#apikeyupdaterequest","text":"Request used to update an API key.","title":"APIKeyUpdateRequest"},{"location":"v2/APIKeyUpdateRequest/#properties","text":"Name Type Description Notes data APIKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeysResponse/","text":"APIKeysResponse Response for a list of API keys. Properties Name Type Description Notes data [PartialAPIKey] Array of API keys. [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeysResponse"},{"location":"v2/APIKeysResponse/#apikeysresponse","text":"Response for a list of API keys.","title":"APIKeysResponse"},{"location":"v2/APIKeysResponse/#properties","text":"Name Type Description Notes data [PartialAPIKey] Array of API keys. [optional] included [APIKeyResponseIncludedItem] Array of objects related to the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeysSort/","text":"APIKeysSort Sorting options Properties Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"modified_at\", \"-modified_at\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeysSort"},{"location":"v2/APIKeysSort/#apikeyssort","text":"Sorting options","title":"APIKeysSort"},{"location":"v2/APIKeysSort/#properties","text":"Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"modified_at\", \"-modified_at\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/APIKeysType/","text":"APIKeysType API Keys resource type. Properties Name Type Description Notes value str API Keys resource type. defaults to \"api_keys\", must be one of [\"api_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"APIKeysType"},{"location":"v2/APIKeysType/#apikeystype","text":"API Keys resource type.","title":"APIKeysType"},{"location":"v2/APIKeysType/#properties","text":"Name Type Description Notes value str API Keys resource type. defaults to \"api_keys\", must be one of [\"api_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyCreateAttributes/","text":"ApplicationKeyCreateAttributes Attributes used to create an application Key. Properties Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyCreateAttributes"},{"location":"v2/ApplicationKeyCreateAttributes/#applicationkeycreateattributes","text":"Attributes used to create an application Key.","title":"ApplicationKeyCreateAttributes"},{"location":"v2/ApplicationKeyCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyCreateData/","text":"ApplicationKeyCreateData Object used to create an application key. Properties Name Type Description Notes attributes ApplicationKeyCreateAttributes type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyCreateData"},{"location":"v2/ApplicationKeyCreateData/#applicationkeycreatedata","text":"Object used to create an application key.","title":"ApplicationKeyCreateData"},{"location":"v2/ApplicationKeyCreateData/#properties","text":"Name Type Description Notes attributes ApplicationKeyCreateAttributes type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyCreateRequest/","text":"ApplicationKeyCreateRequest Request used to create an application key. Properties Name Type Description Notes data ApplicationKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyCreateRequest"},{"location":"v2/ApplicationKeyCreateRequest/#applicationkeycreaterequest","text":"Request used to create an application key.","title":"ApplicationKeyCreateRequest"},{"location":"v2/ApplicationKeyCreateRequest/#properties","text":"Name Type Description Notes data ApplicationKeyCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyRelationships/","text":"ApplicationKeyRelationships Resources related to the application key. Properties Name Type Description Notes created_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyRelationships"},{"location":"v2/ApplicationKeyRelationships/#applicationkeyrelationships","text":"Resources related to the application key.","title":"ApplicationKeyRelationships"},{"location":"v2/ApplicationKeyRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyResponse/","text":"ApplicationKeyResponse Response for retrieving an application key. Properties Name Type Description Notes data FullApplicationKey [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyResponse"},{"location":"v2/ApplicationKeyResponse/#applicationkeyresponse","text":"Response for retrieving an application key.","title":"ApplicationKeyResponse"},{"location":"v2/ApplicationKeyResponse/#properties","text":"Name Type Description Notes data FullApplicationKey [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyResponseIncludedItem/","text":"ApplicationKeyResponseIncludedItem An object related to an application key. Properties Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyResponseIncludedItem"},{"location":"v2/ApplicationKeyResponseIncludedItem/#applicationkeyresponseincludeditem","text":"An object related to an application key.","title":"ApplicationKeyResponseIncludedItem"},{"location":"v2/ApplicationKeyResponseIncludedItem/#properties","text":"Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyUpdateAttributes/","text":"ApplicationKeyUpdateAttributes Attributes used to update an application Key. Properties Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyUpdateAttributes"},{"location":"v2/ApplicationKeyUpdateAttributes/#applicationkeyupdateattributes","text":"Attributes used to update an application Key.","title":"ApplicationKeyUpdateAttributes"},{"location":"v2/ApplicationKeyUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the application key. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyUpdateData/","text":"ApplicationKeyUpdateData Object used to update an application key. Properties Name Type Description Notes attributes ApplicationKeyUpdateAttributes id str ID of the application key. type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyUpdateData"},{"location":"v2/ApplicationKeyUpdateData/#applicationkeyupdatedata","text":"Object used to update an application key.","title":"ApplicationKeyUpdateData"},{"location":"v2/ApplicationKeyUpdateData/#properties","text":"Name Type Description Notes attributes ApplicationKeyUpdateAttributes id str ID of the application key. type ApplicationKeysType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeyUpdateRequest/","text":"ApplicationKeyUpdateRequest Request used to update an application key. Properties Name Type Description Notes data ApplicationKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeyUpdateRequest"},{"location":"v2/ApplicationKeyUpdateRequest/#applicationkeyupdaterequest","text":"Request used to update an application key.","title":"ApplicationKeyUpdateRequest"},{"location":"v2/ApplicationKeyUpdateRequest/#properties","text":"Name Type Description Notes data ApplicationKeyUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeysSort/","text":"ApplicationKeysSort Sorting options Properties Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeysSort"},{"location":"v2/ApplicationKeysSort/#applicationkeyssort","text":"Sorting options","title":"ApplicationKeysSort"},{"location":"v2/ApplicationKeysSort/#properties","text":"Name Type Description Notes value str Sorting options defaults to \"name\", must be one of [\"created_at\", \"-created_at\", \"last4\", \"-last4\", \"name\", \"-name\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ApplicationKeysType/","text":"ApplicationKeysType Application Keys resource type. Properties Name Type Description Notes value str Application Keys resource type. defaults to \"application_keys\", must be one of [\"application_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ApplicationKeysType"},{"location":"v2/ApplicationKeysType/#applicationkeystype","text":"Application Keys resource type.","title":"ApplicationKeysType"},{"location":"v2/ApplicationKeysType/#properties","text":"Name Type Description Notes value str Application Keys resource type. defaults to \"application_keys\", must be one of [\"application_keys\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Creator/","text":"Creator Creator of the object. Properties Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Creator"},{"location":"v2/Creator/#creator","text":"Creator of the object.","title":"Creator"},{"location":"v2/Creator/#properties","text":"Name Type Description Notes email str Email of the creator. [optional] handle str Handle of the creator. [optional] name str Name of the creator. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListAddItemsRequest/","text":"DashboardListAddItemsRequest Request containing a list of dashboards to add. Properties Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to add the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListAddItemsRequest"},{"location":"v2/DashboardListAddItemsRequest/#dashboardlistadditemsrequest","text":"Request containing a list of dashboards to add.","title":"DashboardListAddItemsRequest"},{"location":"v2/DashboardListAddItemsRequest/#properties","text":"Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to add the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListAddItemsResponse/","text":"DashboardListAddItemsResponse Response containing a list of added dashboards. Properties Name Type Description Notes added_dashboards_to_list [DashboardListItemResponse] List of dashboards added to the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListAddItemsResponse"},{"location":"v2/DashboardListAddItemsResponse/#dashboardlistadditemsresponse","text":"Response containing a list of added dashboards.","title":"DashboardListAddItemsResponse"},{"location":"v2/DashboardListAddItemsResponse/#properties","text":"Name Type Description Notes added_dashboards_to_list [DashboardListItemResponse] List of dashboards added to the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListDeleteItemsRequest/","text":"DashboardListDeleteItemsRequest Request containing a list of dashboards to delete. Properties Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to delete from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListDeleteItemsRequest"},{"location":"v2/DashboardListDeleteItemsRequest/#dashboardlistdeleteitemsrequest","text":"Request containing a list of dashboards to delete.","title":"DashboardListDeleteItemsRequest"},{"location":"v2/DashboardListDeleteItemsRequest/#properties","text":"Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to delete from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListDeleteItemsResponse/","text":"DashboardListDeleteItemsResponse Response containing a list of deleted dashboards. Properties Name Type Description Notes deleted_dashboards_from_list [DashboardListItemResponse] List of dashboards deleted from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListDeleteItemsResponse"},{"location":"v2/DashboardListDeleteItemsResponse/#dashboardlistdeleteitemsresponse","text":"Response containing a list of deleted dashboards.","title":"DashboardListDeleteItemsResponse"},{"location":"v2/DashboardListDeleteItemsResponse/#properties","text":"Name Type Description Notes deleted_dashboards_from_list [DashboardListItemResponse] List of dashboards deleted from the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItem/","text":"DashboardListItem A dashboard within a list. Properties Name Type Description Notes id str ID of the dashboard. type DashboardType author Creator [optional] created datetime Date of creation of the dashboard. optional icon str URL to the icon of the dashboard. optional is_favorite bool Whether or not the dashboard is in the favorites. optional is_read_only bool Whether or not the dashboard is read only. optional is_shared bool Whether the dashboard is publicly shared or not. optional modified datetime Date of last edition of the dashboard. optional popularity int Popularity of the dashboard. optional title str Title of the dashboard. optional url str URL path to the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItem"},{"location":"v2/DashboardListItem/#dashboardlistitem","text":"A dashboard within a list.","title":"DashboardListItem"},{"location":"v2/DashboardListItem/#properties","text":"Name Type Description Notes id str ID of the dashboard. type DashboardType author Creator [optional] created datetime Date of creation of the dashboard. optional icon str URL to the icon of the dashboard. optional is_favorite bool Whether or not the dashboard is in the favorites. optional is_read_only bool Whether or not the dashboard is read only. optional is_shared bool Whether the dashboard is publicly shared or not. optional modified datetime Date of last edition of the dashboard. optional popularity int Popularity of the dashboard. optional title str Title of the dashboard. optional url str URL path to the dashboard. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItemRequest/","text":"DashboardListItemRequest A dashboard within a list. Properties Name Type Description Notes id str ID of the dashboard. type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItemRequest"},{"location":"v2/DashboardListItemRequest/#dashboardlistitemrequest","text":"A dashboard within a list.","title":"DashboardListItemRequest"},{"location":"v2/DashboardListItemRequest/#properties","text":"Name Type Description Notes id str ID of the dashboard. type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItemResponse/","text":"DashboardListItemResponse A dashboard within a list. Properties Name Type Description Notes id str ID of the dashboard. [readonly] type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItemResponse"},{"location":"v2/DashboardListItemResponse/#dashboardlistitemresponse","text":"A dashboard within a list.","title":"DashboardListItemResponse"},{"location":"v2/DashboardListItemResponse/#properties","text":"Name Type Description Notes id str ID of the dashboard. [readonly] type DashboardType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListItems/","text":"DashboardListItems Dashboards within a list. Properties Name Type Description Notes dashboards [DashboardListItem] List of dashboards in the dashboard list. total int Number of dashboards in the dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListItems"},{"location":"v2/DashboardListItems/#dashboardlistitems","text":"Dashboards within a list.","title":"DashboardListItems"},{"location":"v2/DashboardListItems/#properties","text":"Name Type Description Notes dashboards [DashboardListItem] List of dashboards in the dashboard list. total int Number of dashboards in the dashboard list. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListUpdateItemsRequest/","text":"DashboardListUpdateItemsRequest Request containing the list of dashboards to update to. Properties Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to update the dashboard list to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListUpdateItemsRequest"},{"location":"v2/DashboardListUpdateItemsRequest/#dashboardlistupdateitemsrequest","text":"Request containing the list of dashboards to update to.","title":"DashboardListUpdateItemsRequest"},{"location":"v2/DashboardListUpdateItemsRequest/#properties","text":"Name Type Description Notes dashboards [DashboardListItemRequest] List of dashboards to update the dashboard list to. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListUpdateItemsResponse/","text":"DashboardListUpdateItemsResponse Response containing a list of updated dashboards. Properties Name Type Description Notes dashboards [DashboardListItemResponse] List of dashboards in the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardListUpdateItemsResponse"},{"location":"v2/DashboardListUpdateItemsResponse/#dashboardlistupdateitemsresponse","text":"Response containing a list of updated dashboards.","title":"DashboardListUpdateItemsResponse"},{"location":"v2/DashboardListUpdateItemsResponse/#properties","text":"Name Type Description Notes dashboards [DashboardListItemResponse] List of dashboards in the dashboard list. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/DashboardListsApi/","text":"datadog_api_client.v2.DashboardListsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list create_dashboard_list_items DashboardListAddItemsResponse create_dashboard_list_items(dashboard_list_id, body) Add Items to a Dashboard List Add dashboards to an existing dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. # example passing only required values which don't have defaults set try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to add items to. body DashboardListAddItemsRequest Dashboards to add to the dashboard list. Return type DashboardListAddItemsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_dashboard_list_items DashboardListDeleteItemsResponse delete_dashboard_list_items(dashboard_list_id, body) Delete items from a dashboard list Delete dashboards from an existing dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to delete items from. body = DashboardListDeleteItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListDeleteItemsRequest | Dashboards to delete from the dashboard list. # example passing only required values which don't have defaults set try: # Delete items from a dashboard list api_response = api_instance.delete_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to delete items from. body DashboardListDeleteItemsRequest Dashboards to delete from the dashboard list. Return type DashboardListDeleteItemsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_dashboard_list_items DashboardListItems get_dashboard_list_items(dashboard_list_id) Get items of a Dashboard List Fetch the dashboard list\u2019s dashboard definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to get items from. # example passing only required values which don't have defaults set try: # Get items of a Dashboard List api_response = api_instance.get_dashboard_list_items(dashboard_list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to get items from. Return type DashboardListItems Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_dashboard_list_items DashboardListUpdateItemsResponse update_dashboard_list_items(dashboard_list_id, body) Update items of a dashboard list Update dashboards of an existing dashboard list. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to update items from. body = DashboardListUpdateItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListUpdateItemsRequest | New dashboards of the dashboard list. # example passing only required values which don't have defaults set try: # Update items of a dashboard list api_response = api_instance.update_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list_items: %s\\n\" % e) Parameters Name Type Description Notes dashboard_list_id int ID of the dashboard list to update items from. body DashboardListUpdateItemsRequest New dashboards of the dashboard list. Return type DashboardListUpdateItemsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.DashboardListsApi"},{"location":"v2/DashboardListsApi/#datadog_api_clientv2dashboardlistsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list","title":"datadog_api_client.v2.DashboardListsApi"},{"location":"v2/DashboardListsApi/#create_dashboard_list_items","text":"DashboardListAddItemsResponse create_dashboard_list_items(dashboard_list_id, body) Add Items to a Dashboard List Add dashboards to an existing dashboard list.","title":"create_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to add items to. body = DashboardListAddItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListAddItemsRequest | Dashboards to add to the dashboard list. # example passing only required values which don't have defaults set try: # Add Items to a Dashboard List api_response = api_instance.create_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->create_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to add items to. body DashboardListAddItemsRequest Dashboards to add to the dashboard list.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type","text":"DashboardListAddItemsResponse","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardListsApi/#delete_dashboard_list_items","text":"DashboardListDeleteItemsResponse delete_dashboard_list_items(dashboard_list_id, body) Delete items from a dashboard list Delete dashboards from an existing dashboard list.","title":"delete_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to delete items from. body = DashboardListDeleteItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListDeleteItemsRequest | Dashboards to delete from the dashboard list. # example passing only required values which don't have defaults set try: # Delete items from a dashboard list api_response = api_instance.delete_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->delete_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters_1","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to delete items from. body DashboardListDeleteItemsRequest Dashboards to delete from the dashboard list.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type_1","text":"DashboardListDeleteItemsResponse","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardListsApi/#get_dashboard_list_items","text":"DashboardListItems get_dashboard_list_items(dashboard_list_id) Get items of a Dashboard List Fetch the dashboard list\u2019s dashboard definitions.","title":"get_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to get items from. # example passing only required values which don't have defaults set try: # Get items of a Dashboard List api_response = api_instance.get_dashboard_list_items(dashboard_list_id) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->get_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters_2","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to get items from.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type_2","text":"DashboardListItems","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardListsApi/#update_dashboard_list_items","text":"DashboardListUpdateItemsResponse update_dashboard_list_items(dashboard_list_id, body) Update items of a dashboard list Update dashboards of an existing dashboard list.","title":"update_dashboard_list_items"},{"location":"v2/DashboardListsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import dashboard_lists_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dashboard_lists_api.DashboardListsApi(api_client) dashboard_list_id = 1 # int | ID of the dashboard list to update items from. body = DashboardListUpdateItemsRequest( dashboards=[ DashboardListItemRequest( id=\"q5j-nti-fv6\", type=DashboardType(\"host_timeboard\"), ), ], ) # DashboardListUpdateItemsRequest | New dashboards of the dashboard list. # example passing only required values which don't have defaults set try: # Update items of a dashboard list api_response = api_instance.update_dashboard_list_items(dashboard_list_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling DashboardListsApi->update_dashboard_list_items: %s\\n\" % e)","title":"Example"},{"location":"v2/DashboardListsApi/#parameters_3","text":"Name Type Description Notes dashboard_list_id int ID of the dashboard list to update items from. body DashboardListUpdateItemsRequest New dashboards of the dashboard list.","title":"Parameters"},{"location":"v2/DashboardListsApi/#return-type_3","text":"DashboardListUpdateItemsResponse","title":"Return type"},{"location":"v2/DashboardListsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/DashboardListsApi/#http-request-headers_3","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/DashboardListsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/DashboardType/","text":"DashboardType The type of the dashboard. Properties Name Type Description Notes value str The type of the dashboard. must be one of [\"custom_timeboard\", \"custom_screenboard\", \"integration_screenboard\", \"integration_timeboard\", \"host_timeboard\", ] [Back to Model list] [Back to API list] [Back to README]","title":"DashboardType"},{"location":"v2/DashboardType/#dashboardtype","text":"The type of the dashboard.","title":"DashboardType"},{"location":"v2/DashboardType/#properties","text":"Name Type Description Notes value str The type of the dashboard. must be one of [\"custom_timeboard\", \"custom_screenboard\", \"integration_screenboard\", \"integration_timeboard\", \"host_timeboard\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullAPIKey/","text":"FullAPIKey Datadog API key. Properties Name Type Description Notes attributes FullAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullAPIKey"},{"location":"v2/FullAPIKey/#fullapikey","text":"Datadog API key.","title":"FullAPIKey"},{"location":"v2/FullAPIKey/#properties","text":"Name Type Description Notes attributes FullAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullAPIKeyAttributes/","text":"FullAPIKeyAttributes Attributes of a full API key. Properties Name Type Description Notes created_at str Creation date of the API key. optional key str The API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullAPIKeyAttributes"},{"location":"v2/FullAPIKeyAttributes/#fullapikeyattributes","text":"Attributes of a full API key.","title":"FullAPIKeyAttributes"},{"location":"v2/FullAPIKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the API key. optional key str The API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullApplicationKey/","text":"FullApplicationKey Datadog application key. Properties Name Type Description Notes attributes FullApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullApplicationKey"},{"location":"v2/FullApplicationKey/#fullapplicationkey","text":"Datadog application key.","title":"FullApplicationKey"},{"location":"v2/FullApplicationKey/#properties","text":"Name Type Description Notes attributes FullApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/FullApplicationKeyAttributes/","text":"FullApplicationKeyAttributes Attributes of a full application key. Properties Name Type Description Notes created_at str Creation date of the application key. optional key str The application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"FullApplicationKeyAttributes"},{"location":"v2/FullApplicationKeyAttributes/#fullapplicationkeyattributes","text":"Attributes of a full application key.","title":"FullApplicationKeyAttributes"},{"location":"v2/FullApplicationKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the application key. optional key str The application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateAttributes/","text":"IncidentCreateAttributes The incident's attributes for a create request. Properties Name Type Description Notes customer_impacted bool A flag indicating whether the incident caused customer impact. title str The title of the incident, which summarizes what happened. fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to create initial selections. [optional] initial_timeline_cells [IncidentTimelineCellCreateAttributes] An array of initial timeline cells to be placed at the beginning of the incident timeline. [optional] notification_handles [str] Notification handles that will be notified of the incident at creation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateAttributes"},{"location":"v2/IncidentCreateAttributes/#incidentcreateattributes","text":"The incident's attributes for a create request.","title":"IncidentCreateAttributes"},{"location":"v2/IncidentCreateAttributes/#properties","text":"Name Type Description Notes customer_impacted bool A flag indicating whether the incident caused customer impact. title str The title of the incident, which summarizes what happened. fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to create initial selections. [optional] initial_timeline_cells [IncidentTimelineCellCreateAttributes] An array of initial timeline cells to be placed at the beginning of the incident timeline. [optional] notification_handles [str] Notification handles that will be notified of the incident at creation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateData/","text":"IncidentCreateData Incident data for a create request. Properties Name Type Description Notes attributes IncidentCreateAttributes type IncidentType relationships IncidentCreateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateData"},{"location":"v2/IncidentCreateData/#incidentcreatedata","text":"Incident data for a create request.","title":"IncidentCreateData"},{"location":"v2/IncidentCreateData/#properties","text":"Name Type Description Notes attributes IncidentCreateAttributes type IncidentType relationships IncidentCreateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateRelationships/","text":"IncidentCreateRelationships The relationships the incident will have with other resources once created. Properties Name Type Description Notes commander RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateRelationships"},{"location":"v2/IncidentCreateRelationships/#incidentcreaterelationships","text":"The relationships the incident will have with other resources once created.","title":"IncidentCreateRelationships"},{"location":"v2/IncidentCreateRelationships/#properties","text":"Name Type Description Notes commander RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentCreateRequest/","text":"IncidentCreateRequest Create request for an incident. Properties Name Type Description Notes data IncidentCreateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentCreateRequest"},{"location":"v2/IncidentCreateRequest/#incidentcreaterequest","text":"Create request for an incident.","title":"IncidentCreateRequest"},{"location":"v2/IncidentCreateRequest/#properties","text":"Name Type Description Notes data IncidentCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributes/","text":"IncidentFieldAttributes Dynamic fields for which selections can be made, with field names as keys. Properties Name Type Description Notes type IncidentFieldAttributesValueType value [str] The multiple values selected for this field. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributes"},{"location":"v2/IncidentFieldAttributes/#incidentfieldattributes","text":"Dynamic fields for which selections can be made, with field names as keys.","title":"IncidentFieldAttributes"},{"location":"v2/IncidentFieldAttributes/#properties","text":"Name Type Description Notes type IncidentFieldAttributesValueType value [str] The multiple values selected for this field. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesMultipleValue/","text":"IncidentFieldAttributesMultipleValue A field with potentially multiple values selected. Properties Name Type Description Notes type IncidentFieldAttributesValueType [optional] value [str] The multiple values selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesMultipleValue"},{"location":"v2/IncidentFieldAttributesMultipleValue/#incidentfieldattributesmultiplevalue","text":"A field with potentially multiple values selected.","title":"IncidentFieldAttributesMultipleValue"},{"location":"v2/IncidentFieldAttributesMultipleValue/#properties","text":"Name Type Description Notes type IncidentFieldAttributesValueType [optional] value [str] The multiple values selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesSingleValue/","text":"IncidentFieldAttributesSingleValue A field with a single value selected. Properties Name Type Description Notes type IncidentFieldAttributesSingleValueType [optional] value str The single value selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesSingleValue"},{"location":"v2/IncidentFieldAttributesSingleValue/#incidentfieldattributessinglevalue","text":"A field with a single value selected.","title":"IncidentFieldAttributesSingleValue"},{"location":"v2/IncidentFieldAttributesSingleValue/#properties","text":"Name Type Description Notes type IncidentFieldAttributesSingleValueType [optional] value str The single value selected for this field. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesSingleValueType/","text":"IncidentFieldAttributesSingleValueType Type of the single value field definitions. Properties Name Type Description Notes value str Type of the single value field definitions. defaults to \"dropdown\", must be one of [\"dropdown\", \"textbox\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesSingleValueType"},{"location":"v2/IncidentFieldAttributesSingleValueType/#incidentfieldattributessinglevaluetype","text":"Type of the single value field definitions.","title":"IncidentFieldAttributesSingleValueType"},{"location":"v2/IncidentFieldAttributesSingleValueType/#properties","text":"Name Type Description Notes value str Type of the single value field definitions. defaults to \"dropdown\", must be one of [\"dropdown\", \"textbox\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentFieldAttributesValueType/","text":"IncidentFieldAttributesValueType Type of the single value field definitions. Properties Name Type Description Notes value str Type of the single value field definitions. defaults to \"multiselect\", must be one of [\"multiselect\", \"textarray\", \"metrictag\", \"autocomplete\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentFieldAttributesValueType"},{"location":"v2/IncidentFieldAttributesValueType/#incidentfieldattributesvaluetype","text":"Type of the single value field definitions.","title":"IncidentFieldAttributesValueType"},{"location":"v2/IncidentFieldAttributesValueType/#properties","text":"Name Type Description Notes value str Type of the single value field definitions. defaults to \"multiselect\", must be one of [\"multiselect\", \"textarray\", \"metrictag\", \"autocomplete\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentIntegrationMetadataType/","text":"IncidentIntegrationMetadataType Integration metadata resource type. Properties Name Type Description Notes value str Integration metadata resource type. defaults to \"incident_integration_metadata\", must be one of [\"incident_integration_metadata\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentIntegrationMetadataType"},{"location":"v2/IncidentIntegrationMetadataType/#incidentintegrationmetadatatype","text":"Integration metadata resource type.","title":"IncidentIntegrationMetadataType"},{"location":"v2/IncidentIntegrationMetadataType/#properties","text":"Name Type Description Notes value str Integration metadata resource type. defaults to \"incident_integration_metadata\", must be one of [\"incident_integration_metadata\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentPostmortemType/","text":"IncidentPostmortemType Incident postmortem resource type. Properties Name Type Description Notes value str Incident postmortem resource type. defaults to \"incident_postmortems\", must be one of [\"incident_postmortems\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentPostmortemType"},{"location":"v2/IncidentPostmortemType/#incidentpostmortemtype","text":"Incident postmortem resource type.","title":"IncidentPostmortemType"},{"location":"v2/IncidentPostmortemType/#properties","text":"Name Type Description Notes value str Incident postmortem resource type. defaults to \"incident_postmortems\", must be one of [\"incident_postmortems\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentRelatedObject/","text":"IncidentRelatedObject Object related to an incident. Properties Name Type Description Notes value str Object related to an incident. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentRelatedObject"},{"location":"v2/IncidentRelatedObject/#incidentrelatedobject","text":"Object related to an incident.","title":"IncidentRelatedObject"},{"location":"v2/IncidentRelatedObject/#properties","text":"Name Type Description Notes value str Object related to an incident. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponse/","text":"IncidentResponse Response with an incident. Properties Name Type Description Notes data IncidentResponseData included [IncidentResponseIncludedItem] Included related resources that the user requested. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponse"},{"location":"v2/IncidentResponse/#incidentresponse","text":"Response with an incident.","title":"IncidentResponse"},{"location":"v2/IncidentResponse/#properties","text":"Name Type Description Notes data IncidentResponseData included [IncidentResponseIncludedItem] Included related resources that the user requested. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseAttributes/","text":"IncidentResponseAttributes The incident's attributes from a response. Properties Name Type Description Notes title str The title of the incident, which summarizes what happened. created datetime Timestamp when the incident was created. optional customer_impact_duration int Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. optional customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str, none_type A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields attached to incidents. [optional] modified datetime Timestamp when the incident was last modified. optional notification_handles [str] Notification handles that will be notified of the incident during update. [optional] postmortem_id str The UUID of the postmortem object attached to the incident. [optional] public_id int The monotonically increasing integer ID for the incident. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] time_to_detect int The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. optional time_to_internal_response int The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. optional time_to_repair int The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. optional time_to_resolve int The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseAttributes"},{"location":"v2/IncidentResponseAttributes/#incidentresponseattributes","text":"The incident's attributes from a response.","title":"IncidentResponseAttributes"},{"location":"v2/IncidentResponseAttributes/#properties","text":"Name Type Description Notes title str The title of the incident, which summarizes what happened. created datetime Timestamp when the incident was created. optional customer_impact_duration int Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. optional customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str, none_type A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields attached to incidents. [optional] modified datetime Timestamp when the incident was last modified. optional notification_handles [str] Notification handles that will be notified of the incident during update. [optional] postmortem_id str The UUID of the postmortem object attached to the incident. [optional] public_id int The monotonically increasing integer ID for the incident. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] time_to_detect int The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. optional time_to_internal_response int The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. optional time_to_repair int The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. optional time_to_resolve int The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseData/","text":"IncidentResponseData Incident data from a response. Properties Name Type Description Notes id str The incident's ID. type IncidentType attributes IncidentResponseAttributes [optional] relationships IncidentResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseData"},{"location":"v2/IncidentResponseData/#incidentresponsedata","text":"Incident data from a response.","title":"IncidentResponseData"},{"location":"v2/IncidentResponseData/#properties","text":"Name Type Description Notes id str The incident's ID. type IncidentType attributes IncidentResponseAttributes [optional] relationships IncidentResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseIncludedItem/","text":"IncidentResponseIncludedItem An object related to an incident that is included in the response. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseIncludedItem"},{"location":"v2/IncidentResponseIncludedItem/#incidentresponseincludeditem","text":"An object related to an incident that is included in the response.","title":"IncidentResponseIncludedItem"},{"location":"v2/IncidentResponseIncludedItem/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentResponseRelationships/","text":"IncidentResponseRelationships The incident's relationships from a response. Properties Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentResponseRelationships"},{"location":"v2/IncidentResponseRelationships/#incidentresponserelationships","text":"The incident's relationships from a response.","title":"IncidentResponseRelationships"},{"location":"v2/IncidentResponseRelationships/#properties","text":"Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceCreateAttributes/","text":"IncidentServiceCreateAttributes The incident service's attributes for a create request. Properties Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceCreateAttributes"},{"location":"v2/IncidentServiceCreateAttributes/#incidentservicecreateattributes","text":"The incident service's attributes for a create request.","title":"IncidentServiceCreateAttributes"},{"location":"v2/IncidentServiceCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceCreateData/","text":"IncidentServiceCreateData Incident Service payload for create requests. Properties Name Type Description Notes type IncidentServiceType attributes IncidentServiceCreateAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceCreateData"},{"location":"v2/IncidentServiceCreateData/#incidentservicecreatedata","text":"Incident Service payload for create requests.","title":"IncidentServiceCreateData"},{"location":"v2/IncidentServiceCreateData/#properties","text":"Name Type Description Notes type IncidentServiceType attributes IncidentServiceCreateAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceCreateRequest/","text":"IncidentServiceCreateRequest Create request with an incident service payload. Properties Name Type Description Notes data IncidentServiceCreateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceCreateRequest"},{"location":"v2/IncidentServiceCreateRequest/#incidentservicecreaterequest","text":"Create request with an incident service payload.","title":"IncidentServiceCreateRequest"},{"location":"v2/IncidentServiceCreateRequest/#properties","text":"Name Type Description Notes data IncidentServiceCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceIncludedItems/","text":"IncidentServiceIncludedItems An object related to an incident service which is present in the included payload. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceIncludedItems"},{"location":"v2/IncidentServiceIncludedItems/#incidentserviceincludeditems","text":"An object related to an incident service which is present in the included payload.","title":"IncidentServiceIncludedItems"},{"location":"v2/IncidentServiceIncludedItems/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceRelationships/","text":"IncidentServiceRelationships The incident service's relationships. Properties Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceRelationships"},{"location":"v2/IncidentServiceRelationships/#incidentservicerelationships","text":"The incident service's relationships.","title":"IncidentServiceRelationships"},{"location":"v2/IncidentServiceRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceResponse/","text":"IncidentServiceResponse Response with an incident service payload. Properties Name Type Description Notes data IncidentServiceResponseData included [IncidentServiceIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceResponse"},{"location":"v2/IncidentServiceResponse/#incidentserviceresponse","text":"Response with an incident service payload.","title":"IncidentServiceResponse"},{"location":"v2/IncidentServiceResponse/#properties","text":"Name Type Description Notes data IncidentServiceResponseData included [IncidentServiceIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceResponseAttributes/","text":"IncidentServiceResponseAttributes The incident service's attributes from a response. Properties Name Type Description Notes created datetime Timestamp of when the incident service was created. optional modified datetime Timestamp of when the incident service was modified. optional name str Name of the incident service. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceResponseAttributes"},{"location":"v2/IncidentServiceResponseAttributes/#incidentserviceresponseattributes","text":"The incident service's attributes from a response.","title":"IncidentServiceResponseAttributes"},{"location":"v2/IncidentServiceResponseAttributes/#properties","text":"Name Type Description Notes created datetime Timestamp of when the incident service was created. optional modified datetime Timestamp of when the incident service was modified. optional name str Name of the incident service. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceResponseData/","text":"IncidentServiceResponseData Incident Service data from responses. Properties Name Type Description Notes id str The incident service's ID. type IncidentServiceType attributes IncidentServiceResponseAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceResponseData"},{"location":"v2/IncidentServiceResponseData/#incidentserviceresponsedata","text":"Incident Service data from responses.","title":"IncidentServiceResponseData"},{"location":"v2/IncidentServiceResponseData/#properties","text":"Name Type Description Notes id str The incident service's ID. type IncidentServiceType attributes IncidentServiceResponseAttributes [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceType/","text":"IncidentServiceType Incident service resource type. Properties Name Type Description Notes value str Incident service resource type. defaults to \"services\", must be one of [\"services\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceType"},{"location":"v2/IncidentServiceType/#incidentservicetype","text":"Incident service resource type.","title":"IncidentServiceType"},{"location":"v2/IncidentServiceType/#properties","text":"Name Type Description Notes value str Incident service resource type. defaults to \"services\", must be one of [\"services\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceUpdateAttributes/","text":"IncidentServiceUpdateAttributes The incident service's attributes for an update request. Properties Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceUpdateAttributes"},{"location":"v2/IncidentServiceUpdateAttributes/#incidentserviceupdateattributes","text":"The incident service's attributes for an update request.","title":"IncidentServiceUpdateAttributes"},{"location":"v2/IncidentServiceUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident service. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceUpdateData/","text":"IncidentServiceUpdateData Incident Service payload for update requests. Properties Name Type Description Notes type IncidentServiceType attributes IncidentServiceUpdateAttributes [optional] id str The incident service's ID. [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceUpdateData"},{"location":"v2/IncidentServiceUpdateData/#incidentserviceupdatedata","text":"Incident Service payload for update requests.","title":"IncidentServiceUpdateData"},{"location":"v2/IncidentServiceUpdateData/#properties","text":"Name Type Description Notes type IncidentServiceType attributes IncidentServiceUpdateAttributes [optional] id str The incident service's ID. [optional] relationships IncidentServiceRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServiceUpdateRequest/","text":"IncidentServiceUpdateRequest Update request with an incident service payload. Properties Name Type Description Notes data IncidentServiceUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServiceUpdateRequest"},{"location":"v2/IncidentServiceUpdateRequest/#incidentserviceupdaterequest","text":"Update request with an incident service payload.","title":"IncidentServiceUpdateRequest"},{"location":"v2/IncidentServiceUpdateRequest/#properties","text":"Name Type Description Notes data IncidentServiceUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServicesApi/","text":"datadog_api_client.v2.IncidentServicesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_service POST /api/v2/services Create a new incident service delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service get_incident_service GET /api/v2/services/{service_id} Get details of an incident service list_incident_services GET /api/v2/services Get a list of all incident services update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service create_incident_service IncidentServiceResponse create_incident_service(body) Create a new incident service Creates a new incident service. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) body = IncidentServiceCreateRequest( data=IncidentServiceCreateData( attributes=IncidentServiceCreateAttributes( name=\"an example service name\", ), relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceCreateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Create a new incident service api_response = api_instance.create_incident_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->create_incident_service: %s\\n\" % e) Parameters Name Type Description Notes body IncidentServiceCreateRequest Incident Service Payload. Return type IncidentServiceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_incident_service delete_incident_service(service_id) Delete an existing incident service Deletes an existing incident service. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. # example passing only required values which don't have defaults set try: # Delete an existing incident service api_instance.delete_incident_service(service_id) except ApiException as e: print(\"Exception when calling IncidentServicesApi->delete_incident_service: %s\\n\" % e) Parameters Name Type Description Notes service_id str The ID of the incident service. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident_service IncidentServiceResponse get_incident_service(service_id) Get details of an incident service Get details of an incident service. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e) Parameters Name Type Description Notes service_id str The ID of the incident service. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] Return type IncidentServiceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_incident_services IncidentServicesResponse list_incident_services() Get a list of all incident services Get all incident services uploaded for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_services\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleServiceName\" # str | A search query that filters services by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident services api_response = api_instance.list_incident_services(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->list_incident_services: %s\\n\" % e) Parameters Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters services by name. [optional] Return type IncidentServicesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_incident_service IncidentServiceResponse update_incident_service(service_id, body) Update an existing incident service Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. body = IncidentServiceUpdateRequest( data=IncidentServiceUpdateData( attributes=IncidentServiceUpdateAttributes( name=\"an example service name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceUpdateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Update an existing incident service api_response = api_instance.update_incident_service(service_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->update_incident_service: %s\\n\" % e) Parameters Name Type Description Notes service_id str The ID of the incident service. body IncidentServiceUpdateRequest Incident Service Payload. Return type IncidentServiceResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.IncidentServicesApi"},{"location":"v2/IncidentServicesApi/#datadog_api_clientv2incidentservicesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_service POST /api/v2/services Create a new incident service delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service get_incident_service GET /api/v2/services/{service_id} Get details of an incident service list_incident_services GET /api/v2/services Get a list of all incident services update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service","title":"datadog_api_client.v2.IncidentServicesApi"},{"location":"v2/IncidentServicesApi/#create_incident_service","text":"IncidentServiceResponse create_incident_service(body) Create a new incident service Creates a new incident service.","title":"create_incident_service"},{"location":"v2/IncidentServicesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) body = IncidentServiceCreateRequest( data=IncidentServiceCreateData( attributes=IncidentServiceCreateAttributes( name=\"an example service name\", ), relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceCreateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Create a new incident service api_response = api_instance.create_incident_service(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->create_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters","text":"Name Type Description Notes body IncidentServiceCreateRequest Incident Service Payload.","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type","text":"IncidentServiceResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details","text":"Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#delete_incident_service","text":"delete_incident_service(service_id) Delete an existing incident service Deletes an existing incident service.","title":"delete_incident_service"},{"location":"v2/IncidentServicesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. # example passing only required values which don't have defaults set try: # Delete an existing incident service api_instance.delete_incident_service(service_id) except ApiException as e: print(\"Exception when calling IncidentServicesApi->delete_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_1","text":"Name Type Description Notes service_id str The ID of the incident service.","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#get_incident_service","text":"IncidentServiceResponse get_incident_service(service_id) Get details of an incident service Get details of an incident service. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.","title":"get_incident_service"},{"location":"v2/IncidentServicesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident service api_response = api_instance.get_incident_service(service_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->get_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_2","text":"Name Type Description Notes service_id str The ID of the incident service. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional]","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_2","text":"IncidentServiceResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#list_incident_services","text":"IncidentServicesResponse list_incident_services() Get a list of all incident services Get all incident services uploaded for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.","title":"list_incident_services"},{"location":"v2/IncidentServicesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_services\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleServiceName\" # str | A search query that filters services by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident services api_response = api_instance.list_incident_services(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->list_incident_services: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_3","text":"Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters services by name. [optional]","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_3","text":"IncidentServicesResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesApi/#update_incident_service","text":"IncidentServiceResponse update_incident_service(service_id, body) Update an existing incident service Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update.","title":"update_incident_service"},{"location":"v2/IncidentServicesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_services_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_service\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_services_api.IncidentServicesApi(api_client) service_id = \"service_id_example\" # str | The ID of the incident service. body = IncidentServiceUpdateRequest( data=IncidentServiceUpdateData( attributes=IncidentServiceUpdateAttributes( name=\"an example service name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentServiceRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentServiceType(\"services\"), ), ) # IncidentServiceUpdateRequest | Incident Service Payload. # example passing only required values which don't have defaults set try: # Update an existing incident service api_response = api_instance.update_incident_service(service_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentServicesApi->update_incident_service: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentServicesApi/#parameters_4","text":"Name Type Description Notes service_id str The ID of the incident service. body IncidentServiceUpdateRequest Incident Service Payload.","title":"Parameters"},{"location":"v2/IncidentServicesApi/#return-type_4","text":"IncidentServiceResponse","title":"Return type"},{"location":"v2/IncidentServicesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentServicesApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentServicesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentServicesResponse/","text":"IncidentServicesResponse Response with a list of incident service payloads. Properties Name Type Description Notes data [IncidentServiceResponseData] An array of incident services. included [IncidentServiceIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServicesResponse"},{"location":"v2/IncidentServicesResponse/#incidentservicesresponse","text":"Response with a list of incident service payloads.","title":"IncidentServicesResponse"},{"location":"v2/IncidentServicesResponse/#properties","text":"Name Type Description Notes data [IncidentServiceResponseData] An array of incident services. included [IncidentServiceIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServicesResponseMeta/","text":"IncidentServicesResponseMeta The metadata object containing pagination metadata. Properties Name Type Description Notes pagination IncidentServicesResponseMetaPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServicesResponseMeta"},{"location":"v2/IncidentServicesResponseMeta/#incidentservicesresponsemeta","text":"The metadata object containing pagination metadata.","title":"IncidentServicesResponseMeta"},{"location":"v2/IncidentServicesResponseMeta/#properties","text":"Name Type Description Notes pagination IncidentServicesResponseMetaPagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentServicesResponseMetaPagination/","text":"IncidentServicesResponseMetaPagination Pagination properties. Properties Name Type Description Notes next_offset int The index of the first element in the next page of results. Equal to page size added to the current offset. [optional] offset int The index of the first element in the results. [optional] size int Maximum size of pages to return. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentServicesResponseMetaPagination"},{"location":"v2/IncidentServicesResponseMetaPagination/#incidentservicesresponsemetapagination","text":"Pagination properties.","title":"IncidentServicesResponseMetaPagination"},{"location":"v2/IncidentServicesResponseMetaPagination/#properties","text":"Name Type Description Notes next_offset int The index of the first element in the next page of results. Equal to page size added to the current offset. [optional] offset int The index of the first element in the results. [optional] size int Maximum size of pages to return. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamCreateAttributes/","text":"IncidentTeamCreateAttributes The incident team's attributes for a create request. Properties Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamCreateAttributes"},{"location":"v2/IncidentTeamCreateAttributes/#incidentteamcreateattributes","text":"The incident team's attributes for a create request.","title":"IncidentTeamCreateAttributes"},{"location":"v2/IncidentTeamCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamCreateData/","text":"IncidentTeamCreateData Incident Team data for a create request. Properties Name Type Description Notes type IncidentTeamType attributes IncidentTeamCreateAttributes [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamCreateData"},{"location":"v2/IncidentTeamCreateData/#incidentteamcreatedata","text":"Incident Team data for a create request.","title":"IncidentTeamCreateData"},{"location":"v2/IncidentTeamCreateData/#properties","text":"Name Type Description Notes type IncidentTeamType attributes IncidentTeamCreateAttributes [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamCreateRequest/","text":"IncidentTeamCreateRequest Create request with an incident team payload. Properties Name Type Description Notes data IncidentTeamCreateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamCreateRequest"},{"location":"v2/IncidentTeamCreateRequest/#incidentteamcreaterequest","text":"Create request with an incident team payload.","title":"IncidentTeamCreateRequest"},{"location":"v2/IncidentTeamCreateRequest/#properties","text":"Name Type Description Notes data IncidentTeamCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamIncludedItems/","text":"IncidentTeamIncludedItems An object related to an incident team which is present in the included payload. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamIncludedItems"},{"location":"v2/IncidentTeamIncludedItems/#incidentteamincludeditems","text":"An object related to an incident team which is present in the included payload.","title":"IncidentTeamIncludedItems"},{"location":"v2/IncidentTeamIncludedItems/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamRelationships/","text":"IncidentTeamRelationships The incident team's relationships. Properties Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamRelationships"},{"location":"v2/IncidentTeamRelationships/#incidentteamrelationships","text":"The incident team's relationships.","title":"IncidentTeamRelationships"},{"location":"v2/IncidentTeamRelationships/#properties","text":"Name Type Description Notes created_by RelationshipToUser [optional] last_modified_by RelationshipToUser [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamResponse/","text":"IncidentTeamResponse Response with an incident team payload. Properties Name Type Description Notes data IncidentTeamResponseData included [IncidentTeamIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamResponse"},{"location":"v2/IncidentTeamResponse/#incidentteamresponse","text":"Response with an incident team payload.","title":"IncidentTeamResponse"},{"location":"v2/IncidentTeamResponse/#properties","text":"Name Type Description Notes data IncidentTeamResponseData included [IncidentTeamIncludedItems] Included objects from relationships. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamResponseAttributes/","text":"IncidentTeamResponseAttributes The incident team's attributes from a response. Properties Name Type Description Notes created datetime Timestamp of when the incident team was created. optional modified datetime Timestamp of when the incident team was modified. optional name str Name of the incident team. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamResponseAttributes"},{"location":"v2/IncidentTeamResponseAttributes/#incidentteamresponseattributes","text":"The incident team's attributes from a response.","title":"IncidentTeamResponseAttributes"},{"location":"v2/IncidentTeamResponseAttributes/#properties","text":"Name Type Description Notes created datetime Timestamp of when the incident team was created. optional modified datetime Timestamp of when the incident team was modified. optional name str Name of the incident team. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamResponseData/","text":"IncidentTeamResponseData Incident Team data from a response. Properties Name Type Description Notes attributes IncidentTeamResponseAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] type IncidentTeamType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamResponseData"},{"location":"v2/IncidentTeamResponseData/#incidentteamresponsedata","text":"Incident Team data from a response.","title":"IncidentTeamResponseData"},{"location":"v2/IncidentTeamResponseData/#properties","text":"Name Type Description Notes attributes IncidentTeamResponseAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] type IncidentTeamType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamType/","text":"IncidentTeamType Incident Team resource type. Properties Name Type Description Notes value str Incident Team resource type. defaults to \"teams\", must be one of [\"teams\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamType"},{"location":"v2/IncidentTeamType/#incidentteamtype","text":"Incident Team resource type.","title":"IncidentTeamType"},{"location":"v2/IncidentTeamType/#properties","text":"Name Type Description Notes value str Incident Team resource type. defaults to \"teams\", must be one of [\"teams\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamUpdateAttributes/","text":"IncidentTeamUpdateAttributes The incident team's attributes for an update request. Properties Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamUpdateAttributes"},{"location":"v2/IncidentTeamUpdateAttributes/#incidentteamupdateattributes","text":"The incident team's attributes for an update request.","title":"IncidentTeamUpdateAttributes"},{"location":"v2/IncidentTeamUpdateAttributes/#properties","text":"Name Type Description Notes name str Name of the incident team. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamUpdateData/","text":"IncidentTeamUpdateData Incident Team data for an update request. Properties Name Type Description Notes type IncidentTeamType attributes IncidentTeamUpdateAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamUpdateData"},{"location":"v2/IncidentTeamUpdateData/#incidentteamupdatedata","text":"Incident Team data for an update request.","title":"IncidentTeamUpdateData"},{"location":"v2/IncidentTeamUpdateData/#properties","text":"Name Type Description Notes type IncidentTeamType attributes IncidentTeamUpdateAttributes [optional] id str The incident team's ID. [optional] relationships IncidentTeamRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamUpdateRequest/","text":"IncidentTeamUpdateRequest Update request with an incident team payload. Properties Name Type Description Notes data IncidentTeamUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamUpdateRequest"},{"location":"v2/IncidentTeamUpdateRequest/#incidentteamupdaterequest","text":"Update request with an incident team payload.","title":"IncidentTeamUpdateRequest"},{"location":"v2/IncidentTeamUpdateRequest/#properties","text":"Name Type Description Notes data IncidentTeamUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTeamsApi/","text":"datadog_api_client.v2.IncidentTeamsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_team POST /api/v2/teams Create a new incident team delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team list_incident_teams GET /api/v2/teams Get a list of all incident teams update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team create_incident_team IncidentTeamResponse create_incident_team(body) Create a new incident team Creates a new incident team. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) body = IncidentTeamCreateRequest( data=IncidentTeamCreateData( attributes=IncidentTeamCreateAttributes( name=\"team name\", ), relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamCreateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Create a new incident team api_response = api_instance.create_incident_team(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->create_incident_team: %s\\n\" % e) Parameters Name Type Description Notes body IncidentTeamCreateRequest Incident Team Payload. Return type IncidentTeamResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_incident_team delete_incident_team(team_id) Delete an existing incident team Deletes an existing incident team. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. # example passing only required values which don't have defaults set try: # Delete an existing incident team api_instance.delete_incident_team(team_id) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->delete_incident_team: %s\\n\" % e) Parameters Name Type Description Notes team_id str The ID of the incident team. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident_team IncidentTeamResponse get_incident_team(team_id) Get details of an incident team Get details of an incident team. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e) Parameters Name Type Description Notes team_id str The ID of the incident team. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] Return type IncidentTeamResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_incident_teams IncidentTeamsResponse list_incident_teams() Get a list of all incident teams Get all incident teams for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_teams\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleTeamName\" # str | A search query that filters teams by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident teams api_response = api_instance.list_incident_teams(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->list_incident_teams: %s\\n\" % e) Parameters Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters teams by name. [optional] Return type IncidentTeamsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_incident_team IncidentTeamResponse update_incident_team(team_id, body) Update an existing incident team Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. body = IncidentTeamUpdateRequest( data=IncidentTeamUpdateData( attributes=IncidentTeamUpdateAttributes( name=\"team name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamUpdateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Update an existing incident team api_response = api_instance.update_incident_team(team_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->update_incident_team: %s\\n\" % e) Parameters Name Type Description Notes team_id str The ID of the incident team. body IncidentTeamUpdateRequest Incident Team Payload. Return type IncidentTeamResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.IncidentTeamsApi"},{"location":"v2/IncidentTeamsApi/#datadog_api_clientv2incidentteamsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident_team POST /api/v2/teams Create a new incident team delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team list_incident_teams GET /api/v2/teams Get a list of all incident teams update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team","title":"datadog_api_client.v2.IncidentTeamsApi"},{"location":"v2/IncidentTeamsApi/#create_incident_team","text":"IncidentTeamResponse create_incident_team(body) Create a new incident team Creates a new incident team.","title":"create_incident_team"},{"location":"v2/IncidentTeamsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) body = IncidentTeamCreateRequest( data=IncidentTeamCreateData( attributes=IncidentTeamCreateAttributes( name=\"team name\", ), relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamCreateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Create a new incident team api_response = api_instance.create_incident_team(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->create_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters","text":"Name Type Description Notes body IncidentTeamCreateRequest Incident Team Payload.","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type","text":"IncidentTeamResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details","text":"Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#delete_incident_team","text":"delete_incident_team(team_id) Delete an existing incident team Deletes an existing incident team.","title":"delete_incident_team"},{"location":"v2/IncidentTeamsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. # example passing only required values which don't have defaults set try: # Delete an existing incident team api_instance.delete_incident_team(team_id) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->delete_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_1","text":"Name Type Description Notes team_id str The ID of the incident team.","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#get_incident_team","text":"IncidentTeamResponse get_incident_team(team_id) Get details of an incident team Get details of an incident team. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams.","title":"get_incident_team"},{"location":"v2/IncidentTeamsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get details of an incident team api_response = api_instance.get_incident_team(team_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->get_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_2","text":"Name Type Description Notes team_id str The ID of the incident team. include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional]","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_2","text":"IncidentTeamResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#list_incident_teams","text":"IncidentTeamsResponse list_incident_teams() Get a list of all incident teams Get all incident teams for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident teams.","title":"list_incident_teams"},{"location":"v2/IncidentTeamsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incident_teams\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) include = IncidentRelatedObject(\"users\") # IncidentRelatedObject | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 filter = \"ExampleTeamName\" # str | A search query that filters teams by name. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of all incident teams api_response = api_instance.list_incident_teams(include=include, page_size=page_size, page_offset=page_offset, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->list_incident_teams: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_3","text":"Name Type Description Notes include IncidentRelatedObject Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 filter str A search query that filters teams by name. [optional]","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_3","text":"IncidentTeamsResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsApi/#update_incident_team","text":"IncidentTeamResponse update_incident_team(team_id, body) Update an existing incident team Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update.","title":"update_incident_team"},{"location":"v2/IncidentTeamsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incident_teams_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident_team\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incident_teams_api.IncidentTeamsApi(api_client) team_id = \"team_id_example\" # str | The ID of the incident team. body = IncidentTeamUpdateRequest( data=IncidentTeamUpdateData( attributes=IncidentTeamUpdateAttributes( name=\"team name\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentTeamRelationships( created_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), last_modified_by=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentTeamType(\"teams\"), ), ) # IncidentTeamUpdateRequest | Incident Team Payload. # example passing only required values which don't have defaults set try: # Update an existing incident team api_response = api_instance.update_incident_team(team_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentTeamsApi->update_incident_team: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentTeamsApi/#parameters_4","text":"Name Type Description Notes team_id str The ID of the incident team. body IncidentTeamUpdateRequest Incident Team Payload.","title":"Parameters"},{"location":"v2/IncidentTeamsApi/#return-type_4","text":"IncidentTeamResponse","title":"Return type"},{"location":"v2/IncidentTeamsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentTeamsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentTeamsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentTeamsResponse/","text":"IncidentTeamsResponse Response with a list of incident team payloads. Properties Name Type Description Notes data [IncidentTeamResponseData] An array of incident teams. included [IncidentTeamIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTeamsResponse"},{"location":"v2/IncidentTeamsResponse/#incidentteamsresponse","text":"Response with a list of incident team payloads.","title":"IncidentTeamsResponse"},{"location":"v2/IncidentTeamsResponse/#properties","text":"Name Type Description Notes data [IncidentTeamResponseData] An array of incident teams. included [IncidentTeamIncludedItems] Included related resources which the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellCreateAttributes/","text":"IncidentTimelineCellCreateAttributes The timeline cell's attributes for a create request. Properties Name Type Description Notes important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False cell_type IncidentTimelineCellMarkdownContentType [optional] content IncidentTimelineCellMarkdownCreateAttributesContent [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellCreateAttributes"},{"location":"v2/IncidentTimelineCellCreateAttributes/#incidenttimelinecellcreateattributes","text":"The timeline cell's attributes for a create request.","title":"IncidentTimelineCellCreateAttributes"},{"location":"v2/IncidentTimelineCellCreateAttributes/#properties","text":"Name Type Description Notes important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False cell_type IncidentTimelineCellMarkdownContentType [optional] content IncidentTimelineCellMarkdownCreateAttributesContent [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellMarkdownContentType/","text":"IncidentTimelineCellMarkdownContentType Type of the Markdown timeline cell. Properties Name Type Description Notes value str Type of the Markdown timeline cell. defaults to \"markdown\", must be one of [\"markdown\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellMarkdownContentType"},{"location":"v2/IncidentTimelineCellMarkdownContentType/#incidenttimelinecellmarkdowncontenttype","text":"Type of the Markdown timeline cell.","title":"IncidentTimelineCellMarkdownContentType"},{"location":"v2/IncidentTimelineCellMarkdownContentType/#properties","text":"Name Type Description Notes value str Type of the Markdown timeline cell. defaults to \"markdown\", must be one of [\"markdown\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributes/","text":"IncidentTimelineCellMarkdownCreateAttributes Timeline cell data for Markdown timeline cells for a create request. Properties Name Type Description Notes cell_type IncidentTimelineCellMarkdownContentType content IncidentTimelineCellMarkdownCreateAttributesContent important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellMarkdownCreateAttributes"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributes/#incidenttimelinecellmarkdowncreateattributes","text":"Timeline cell data for Markdown timeline cells for a create request.","title":"IncidentTimelineCellMarkdownCreateAttributes"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributes/#properties","text":"Name Type Description Notes cell_type IncidentTimelineCellMarkdownContentType content IncidentTimelineCellMarkdownCreateAttributesContent important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributesContent/","text":"IncidentTimelineCellMarkdownCreateAttributesContent The Markdown timeline cell contents. Properties Name Type Description Notes content str The Markdown content of the cell. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentTimelineCellMarkdownCreateAttributesContent"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributesContent/#incidenttimelinecellmarkdowncreateattributescontent","text":"The Markdown timeline cell contents.","title":"IncidentTimelineCellMarkdownCreateAttributesContent"},{"location":"v2/IncidentTimelineCellMarkdownCreateAttributesContent/#properties","text":"Name Type Description Notes content str The Markdown content of the cell. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentType/","text":"IncidentType Incident resource type. Properties Name Type Description Notes value str Incident resource type. defaults to \"incidents\", must be one of [\"incidents\", ] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentType"},{"location":"v2/IncidentType/#incidenttype","text":"Incident resource type.","title":"IncidentType"},{"location":"v2/IncidentType/#properties","text":"Name Type Description Notes value str Incident resource type. defaults to \"incidents\", must be one of [\"incidents\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateAttributes/","text":"IncidentUpdateAttributes The incident's attributes for an update request. Properties Name Type Description Notes customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to update selections. [optional] notification_handles [str] Notification handles that will be notified of the incident during update. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] title str The title of the incident, which summarizes what happened. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateAttributes"},{"location":"v2/IncidentUpdateAttributes/#incidentupdateattributes","text":"The incident's attributes for an update request.","title":"IncidentUpdateAttributes"},{"location":"v2/IncidentUpdateAttributes/#properties","text":"Name Type Description Notes customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional] customer_impact_scope str A summary of the impact customers experienced during the incident. [optional] customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional] customer_impacted bool A flag indicating whether the incident caused customer impact. [optional] detected datetime, none_type Timestamp when the incident was detected. [optional] fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to update selections. [optional] notification_handles [str] Notification handles that will be notified of the incident during update. [optional] resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional] title str The title of the incident, which summarizes what happened. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateData/","text":"IncidentUpdateData Incident data for an update request. Properties Name Type Description Notes id str The team's ID. type IncidentType attributes IncidentUpdateAttributes [optional] relationships IncidentUpdateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateData"},{"location":"v2/IncidentUpdateData/#incidentupdatedata","text":"Incident data for an update request.","title":"IncidentUpdateData"},{"location":"v2/IncidentUpdateData/#properties","text":"Name Type Description Notes id str The team's ID. type IncidentType attributes IncidentUpdateAttributes [optional] relationships IncidentUpdateRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateRelationships/","text":"IncidentUpdateRelationships The incident's relationships for an update request. Properties Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateRelationships"},{"location":"v2/IncidentUpdateRelationships/#incidentupdaterelationships","text":"The incident's relationships for an update request.","title":"IncidentUpdateRelationships"},{"location":"v2/IncidentUpdateRelationships/#properties","text":"Name Type Description Notes commander_user RelationshipToUser [optional] created_by_user RelationshipToUser [optional] integrations RelationshipToIncidentIntegrationMetadatas [optional] last_modified_by_user RelationshipToUser [optional] postmortem RelationshipToIncidentPostmortem [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentUpdateRequest/","text":"IncidentUpdateRequest Update request for an incident. Properties Name Type Description Notes data IncidentUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"IncidentUpdateRequest"},{"location":"v2/IncidentUpdateRequest/#incidentupdaterequest","text":"Update request for an incident.","title":"IncidentUpdateRequest"},{"location":"v2/IncidentUpdateRequest/#properties","text":"Name Type Description Notes data IncidentUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/IncidentsApi/","text":"datadog_api_client.v2.IncidentsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident POST /api/v2/incidents Create an incident delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident list_incidents GET /api/v2/incidents Get a list of incidents update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident create_incident IncidentResponse create_incident(body) Create an incident Create an incident. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) body = IncidentCreateRequest( data=IncidentCreateData( attributes=IncidentCreateAttributes( customer_impacted=False, fields={ \"key\": IncidentFieldAttributes(), }, initial_timeline_cells=[ IncidentTimelineCellCreateAttributes(), ], notification_handles=[ \"@test.user@test.com\", ], title=\"A test incident title\", ), relationships=IncidentCreateRelationships( commander=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentCreateRequest | Incident payload. # example passing only required values which don't have defaults set try: # Create an incident api_response = api_instance.create_incident(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->create_incident: %s\\n\" % e) Parameters Name Type Description Notes body IncidentCreateRequest Incident payload. Return type IncidentResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_incident delete_incident(incident_id) Delete an existing incident Deletes an existing incident from the users organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. # example passing only required values which don't have defaults set try: # Delete an existing incident api_instance.delete_incident(incident_id) except ApiException as e: print(\"Exception when calling IncidentsApi->delete_incident: %s\\n\" % e) Parameters Name Type Description Notes incident_id str The UUID the incident. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_incident IncidentResponse get_incident(incident_id) Get the details of an incident Get the details of an incident by incident_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get the details of an incident api_response = api_instance.get_incident(incident_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get the details of an incident api_response = api_instance.get_incident(incident_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e) Parameters Name Type Description Notes incident_id str The UUID the incident. include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional] Return type IncidentResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_incidents IncidentsResponse list_incidents() Get a list of incidents Get all incidents for the user's organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incidents\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # Get a list of incidents api_response = api_instance.list_incidents(include=include, page_size=page_size, page_offset=page_offset) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->list_incidents: %s\\n\" % e) Parameters Name Type Description Notes include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0 Return type IncidentsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_incident IncidentResponse update_incident(incident_id, body) Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. body = IncidentUpdateRequest( data=IncidentUpdateData( attributes=IncidentUpdateAttributes( customer_impact_end=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impact_scope=\"Example customer impact scope\", customer_impact_start=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impacted=False, detected=dateutil_parser('1970-01-01T00:00:00.00Z'), fields={ \"key\": IncidentFieldAttributes(), }, notification_handles=[ \"@test.user@test.com\", ], resolved=dateutil_parser('1970-01-01T00:00:00.00Z'), title=\"A test incident title\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentUpdateRelationships( commander_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), created_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), integrations=RelationshipToIncidentIntegrationMetadatas( data=[ RelationshipToIncidentIntegrationMetadataData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentIntegrationMetadataType(\"incident_integration_metadata\"), ), ], ), last_modified_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), postmortem=RelationshipToIncidentPostmortem( data=RelationshipToIncidentPostmortemData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentPostmortemType(\"incident_postmortems\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentUpdateRequest | Incident Payload. # example passing only required values which don't have defaults set try: # Update an existing incident api_response = api_instance.update_incident(incident_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->update_incident: %s\\n\" % e) Parameters Name Type Description Notes incident_id str The UUID the incident. body IncidentUpdateRequest Incident Payload. Return type IncidentResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.IncidentsApi"},{"location":"v2/IncidentsApi/#datadog_api_clientv2incidentsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_incident POST /api/v2/incidents Create an incident delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident list_incidents GET /api/v2/incidents Get a list of incidents update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident","title":"datadog_api_client.v2.IncidentsApi"},{"location":"v2/IncidentsApi/#create_incident","text":"IncidentResponse create_incident(body) Create an incident Create an incident.","title":"create_incident"},{"location":"v2/IncidentsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) body = IncidentCreateRequest( data=IncidentCreateData( attributes=IncidentCreateAttributes( customer_impacted=False, fields={ \"key\": IncidentFieldAttributes(), }, initial_timeline_cells=[ IncidentTimelineCellCreateAttributes(), ], notification_handles=[ \"@test.user@test.com\", ], title=\"A test incident title\", ), relationships=IncidentCreateRelationships( commander=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentCreateRequest | Incident payload. # example passing only required values which don't have defaults set try: # Create an incident api_response = api_instance.create_incident(body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->create_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters","text":"Name Type Description Notes body IncidentCreateRequest Incident payload.","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type","text":"IncidentResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details","text":"Status code Description Response headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#delete_incident","text":"delete_incident(incident_id) Delete an existing incident Deletes an existing incident from the users organization.","title":"delete_incident"},{"location":"v2/IncidentsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. # example passing only required values which don't have defaults set try: # Delete an existing incident api_instance.delete_incident(incident_id) except ApiException as e: print(\"Exception when calling IncidentsApi->delete_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_1","text":"Name Type Description Notes incident_id str The UUID the incident.","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#get_incident","text":"IncidentResponse get_incident(incident_id) Get the details of an incident Get the details of an incident by incident_id .","title":"get_incident"},{"location":"v2/IncidentsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"get_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) # example passing only required values which don't have defaults set try: # Get the details of an incident api_response = api_instance.get_incident(incident_id) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get the details of an incident api_response = api_instance.get_incident(incident_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->get_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_2","text":"Name Type Description Notes incident_id str The UUID the incident. include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional]","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_2","text":"IncidentResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#list_incidents","text":"IncidentsResponse list_incidents() Get a list of incidents Get all incidents for the user's organization.","title":"list_incidents"},{"location":"v2/IncidentsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_incidents\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) include = [ IncidentRelatedObject(\"users\"), ] # [IncidentRelatedObject] | Specifies which types of related objects should be included in the response. (optional) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_offset = 0 # int | Specific offset to use as the beginning of the returned page. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # Get a list of incidents api_response = api_instance.list_incidents(include=include, page_size=page_size, page_offset=page_offset) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->list_incidents: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_3","text":"Name Type Description Notes include [IncidentRelatedObject] Specifies which types of related objects should be included in the response. [optional] page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_offset int Specific offset to use as the beginning of the returned page. [optional] if omitted the server will use the default value of 0","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_3","text":"IncidentsResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsApi/#update_incident","text":"IncidentResponse update_incident(incident_id, body) Update an existing incident Updates an incident. Provide only the attributes that should be updated as this request is a partial update.","title":"update_incident"},{"location":"v2/IncidentsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import incidents_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_incident\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = incidents_api.IncidentsApi(api_client) incident_id = \"incident_id_example\" # str | The UUID the incident. body = IncidentUpdateRequest( data=IncidentUpdateData( attributes=IncidentUpdateAttributes( customer_impact_end=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impact_scope=\"Example customer impact scope\", customer_impact_start=dateutil_parser('1970-01-01T00:00:00.00Z'), customer_impacted=False, detected=dateutil_parser('1970-01-01T00:00:00.00Z'), fields={ \"key\": IncidentFieldAttributes(), }, notification_handles=[ \"@test.user@test.com\", ], resolved=dateutil_parser('1970-01-01T00:00:00.00Z'), title=\"A test incident title\", ), id=\"00000000-0000-0000-0000-000000000000\", relationships=IncidentUpdateRelationships( commander_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), created_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), integrations=RelationshipToIncidentIntegrationMetadatas( data=[ RelationshipToIncidentIntegrationMetadataData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentIntegrationMetadataType(\"incident_integration_metadata\"), ), ], ), last_modified_by_user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), postmortem=RelationshipToIncidentPostmortem( data=RelationshipToIncidentPostmortemData( id=\"00000000-0000-0000-0000-000000000000\", type=IncidentPostmortemType(\"incident_postmortems\"), ), ), ), type=IncidentType(\"incidents\"), ), ) # IncidentUpdateRequest | Incident Payload. # example passing only required values which don't have defaults set try: # Update an existing incident api_response = api_instance.update_incident(incident_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling IncidentsApi->update_incident: %s\\n\" % e)","title":"Example"},{"location":"v2/IncidentsApi/#parameters_4","text":"Name Type Description Notes incident_id str The UUID the incident. body IncidentUpdateRequest Incident Payload.","title":"Parameters"},{"location":"v2/IncidentsApi/#return-type_4","text":"IncidentResponse","title":"Return type"},{"location":"v2/IncidentsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/IncidentsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/IncidentsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/IncidentsResponse/","text":"IncidentsResponse Response with a list of incidents. Properties Name Type Description Notes data [IncidentResponseData] An array of incidents. included [IncidentResponseIncludedItem] Included related resources that the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"IncidentsResponse"},{"location":"v2/IncidentsResponse/#incidentsresponse","text":"Response with a list of incidents.","title":"IncidentsResponse"},{"location":"v2/IncidentsResponse/#properties","text":"Name Type Description Notes data [IncidentResponseData] An array of incidents. included [IncidentResponseIncludedItem] Included related resources that the user requested. optional meta IncidentServicesResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/KeyManagementApi/","text":"datadog_api_client.v2.KeyManagementApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v2/api_keys Create an API key create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key 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 GET /api/v2/api_keys/{api_key_id} Get API key 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 GET /api/v2/api_keys Get all API keys list_application_keys GET /api/v2/application_keys Get all application keys list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key 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 APIKeyResponse create_api_key(body) Create an API key Create an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = APIKeyCreateRequest( data=APIKeyCreateData( attributes=APIKeyCreateAttributes( name=\"API Key for submitting metrics\", ), type=APIKeysType(\"api_keys\"), ), ) # APIKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e) Parameters Name Type Description Notes body APIKeyCreateRequest Return type APIKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_current_user_application_key ApplicationKeyResponse create_current_user_application_key(body) Create an application key for current user Create an application key for current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKeyCreateRequest( data=ApplicationKeyCreateData( attributes=ApplicationKeyCreateAttributes( name=\"Application Key for submitting metrics\", ), type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an application key for current user api_response = api_instance.create_current_user_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes body ApplicationKeyCreateRequest Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_api_key delete_api_key(api_key_id) Delete an API key Delete an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. # example passing only required values which don't have defaults set try: # Delete an API key api_instance.delete_api_key(api_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e) Parameters Name Type Description Notes api_key_id str The ID of the API key. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_application_key delete_application_key(app_key_id) Delete an application key Delete an application key Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key api_instance.delete_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_current_user_application_key delete_current_user_application_key(app_key_id) Delete an application key owned by current user Delete an application key owned by current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key owned by current user api_instance.delete_current_user_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_api_key APIKeyResponse get_api_key(api_key_id) Get API key Get an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(api_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get API key api_response = api_instance.get_api_key(api_key_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) Parameters Name Type Description Notes api_key_id str The ID of the API key. include str 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 APIKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_current_user_application_key ApplicationKeyResponse get_current_user_application_key(app_key_id) Get one application key owned by current user Get an application key owned by current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Get one application key owned by current user api_response = api_instance.get_current_user_application_key(app_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_api_keys APIKeysResponse list_api_keys() Get all API keys List all API keys available for your account. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = APIKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter API keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or before the specified date. (optional) filter_modified_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or after the specified date. (optional) filter_modified_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or before the specified date. (optional) include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all API keys api_response = api_instance.list_api_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end, filter_modified_at_start=filter_modified_at_start, filter_modified_at_end=filter_modified_at_end, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter API keys by the specified string. [optional] filter_created_at_start str Only include API keys created on or after the specified date. [optional] filter_created_at_end str Only include API keys created on or before the specified date. [optional] filter_modified_at_start str Only include API keys modified on or after the specified date. [optional] filter_modified_at_end str Only include API keys modified on or before the specified date. [optional] include str 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 APIKeysResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_application_keys ListApplicationKeysResponse list_application_keys() Get all application keys List all application keys available for your org Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys api_response = api_instance.list_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional] Return type ListApplicationKeysResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_current_user_application_keys ListApplicationKeysResponse list_current_user_application_keys() Get all application keys owned by current user List all application keys available for current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys owned by current user api_response = api_instance.list_current_user_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_current_user_application_keys: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional] Return type ListApplicationKeysResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_api_key APIKeyResponse update_api_key(api_key_id, body) Edit an API key Update an API key. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. body = APIKeyUpdateRequest( data=APIKeyUpdateData( attributes=APIKeyUpdateAttributes( name=\"API Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=APIKeysType(\"api_keys\"), ), ) # APIKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(api_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e) Parameters Name Type Description Notes api_key_id str The ID of the API key. body APIKeyUpdateRequest Return type APIKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_application_key ApplicationKeyResponse update_application_key(app_key_id, body) Edit an application key Edit an application key Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_current_user_application_key ApplicationKeyResponse update_current_user_application_key(app_key_id, body) Edit an application key owned by current user Edit an application key owned by current user Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key owned by current user api_response = api_instance.update_current_user_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_current_user_application_key: %s\\n\" % e) Parameters Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest Return type ApplicationKeyResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.KeyManagementApi"},{"location":"v2/KeyManagementApi/#datadog_api_clientv2keymanagementapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_api_key POST /api/v2/api_keys Create an API key create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key 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 GET /api/v2/api_keys/{api_key_id} Get API key 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 GET /api/v2/api_keys Get all API keys list_application_keys GET /api/v2/application_keys Get all application keys list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key update_current_user_application_key PATCH /api/v2/current_user/application_keys/{app_key_id} Edit an application key owned by current user","title":"datadog_api_client.v2.KeyManagementApi"},{"location":"v2/KeyManagementApi/#create_api_key","text":"APIKeyResponse create_api_key(body) Create an API key Create an API key.","title":"create_api_key"},{"location":"v2/KeyManagementApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = APIKeyCreateRequest( data=APIKeyCreateData( attributes=APIKeyCreateAttributes( name=\"API Key for submitting metrics\", ), type=APIKeysType(\"api_keys\"), ), ) # APIKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an API key api_response = api_instance.create_api_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters","text":"Name Type Description Notes body APIKeyCreateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type","text":"APIKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details","text":"Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#create_current_user_application_key","text":"ApplicationKeyResponse create_current_user_application_key(body) Create an application key for current user Create an application key for current user","title":"create_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) body = ApplicationKeyCreateRequest( data=ApplicationKeyCreateData( attributes=ApplicationKeyCreateAttributes( name=\"Application Key for submitting metrics\", ), type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyCreateRequest | # example passing only required values which don't have defaults set try: # Create an application key for current user api_response = api_instance.create_current_user_application_key(body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->create_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_1","text":"Name Type Description Notes body ApplicationKeyCreateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_1","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_1","text":"Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#delete_api_key","text":"delete_api_key(api_key_id) Delete an API key Delete an API key.","title":"delete_api_key"},{"location":"v2/KeyManagementApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. # example passing only required values which don't have defaults set try: # Delete an API key api_instance.delete_api_key(api_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_2","text":"Name Type Description Notes api_key_id str The ID of the API key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_2","text":"void (empty response body)","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_2","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#delete_application_key","text":"delete_application_key(app_key_id) Delete an application key Delete an application key","title":"delete_application_key"},{"location":"v2/KeyManagementApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key api_instance.delete_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_3","text":"Name Type Description Notes app_key_id str The ID of the application key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_3","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#delete_current_user_application_key","text":"delete_current_user_application_key(app_key_id) Delete an application key owned by current user Delete an application key owned by current user","title":"delete_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Delete an application key owned by current user api_instance.delete_current_user_application_key(app_key_id) except ApiException as e: print(\"Exception when calling KeyManagementApi->delete_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_4","text":"Name Type Description Notes app_key_id str The ID of the application key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_4","text":"void (empty response body)","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_4","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#get_api_key","text":"APIKeyResponse get_api_key(api_key_id) Get API key Get an API key.","title":"get_api_key"},{"location":"v2/KeyManagementApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set try: # Get API key api_response = api_instance.get_api_key(api_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get API key api_response = api_instance.get_api_key(api_key_id, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_5","text":"Name Type Description Notes api_key_id str The ID of the API key. include str Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_5","text":"APIKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#get_current_user_application_key","text":"ApplicationKeyResponse get_current_user_application_key(app_key_id) Get one application key owned by current user Get an application key owned by current user","title":"get_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. # example passing only required values which don't have defaults set try: # Get one application key owned by current user api_response = api_instance.get_current_user_application_key(app_key_id) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->get_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_6","text":"Name Type Description Notes app_key_id str The ID of the application key.","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_6","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#list_api_keys","text":"APIKeysResponse list_api_keys() Get all API keys List all API keys available for your account.","title":"list_api_keys"},{"location":"v2/KeyManagementApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = APIKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter API keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys created on or before the specified date. (optional) filter_modified_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or after the specified date. (optional) filter_modified_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include API keys modified on or before the specified date. (optional) include = \"created_by,modified_by\" # str | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all API keys api_response = api_instance.list_api_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end, filter_modified_at_start=filter_modified_at_start, filter_modified_at_end=filter_modified_at_end, include=include) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_api_keys: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_7","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter API keys by the specified string. [optional] filter_created_at_start str Only include API keys created on or after the specified date. [optional] filter_created_at_end str Only include API keys created on or before the specified date. [optional] filter_modified_at_start str Only include API keys modified on or after the specified date. [optional] filter_modified_at_end str Only include API keys modified on or before the specified date. [optional] include str Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_7","text":"APIKeysResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#list_application_keys","text":"ListApplicationKeysResponse list_application_keys() Get all application keys List all application keys available for your org","title":"list_application_keys"},{"location":"v2/KeyManagementApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys api_response = api_instance.list_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_application_keys: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_8","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_8","text":"ListApplicationKeysResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#list_current_user_application_keys","text":"ListApplicationKeysResponse list_current_user_application_keys() Get all application keys owned by current user List all application keys available for current user","title":"list_current_user_application_keys"},{"location":"v2/KeyManagementApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = ApplicationKeysSort(\"name\") # 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) filter = \"filter_example\" # str | Filter application keys by the specified string. (optional) filter_created_at_start = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or after the specified date. (optional) filter_created_at_end = \"2020-11-24T18:46:21+00:00\" # str | Only include application keys created on or before the specified date. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all application keys owned by current user api_response = api_instance.list_current_user_application_keys(page_size=page_size, page_number=page_number, sort=sort, filter=filter, filter_created_at_start=filter_created_at_start, filter_created_at_end=filter_created_at_end) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->list_current_user_application_keys: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_9","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter application keys by the specified string. [optional] filter_created_at_start str Only include application keys created on or after the specified date. [optional] filter_created_at_end str Only include application keys created on or before the specified date. [optional]","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_9","text":"ListApplicationKeysResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_9","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#update_api_key","text":"APIKeyResponse update_api_key(api_key_id, body) Edit an API key Update an API key.","title":"update_api_key"},{"location":"v2/KeyManagementApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) api_key_id = \"api_key_id_example\" # str | The ID of the API key. body = APIKeyUpdateRequest( data=APIKeyUpdateData( attributes=APIKeyUpdateAttributes( name=\"API Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=APIKeysType(\"api_keys\"), ), ) # APIKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an API key api_response = api_instance.update_api_key(api_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_api_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_10","text":"Name Type Description Notes api_key_id str The ID of the API key. body APIKeyUpdateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_10","text":"APIKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_10","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#update_application_key","text":"ApplicationKeyResponse update_application_key(app_key_id, body) Edit an application key Edit an application key","title":"update_application_key"},{"location":"v2/KeyManagementApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key api_response = api_instance.update_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_11","text":"Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_11","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_11","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/KeyManagementApi/#update_current_user_application_key","text":"ApplicationKeyResponse update_current_user_application_key(app_key_id, body) Edit an application key owned by current user Edit an application key owned by current user","title":"update_current_user_application_key"},{"location":"v2/KeyManagementApi/#example_12","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import key_management_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = key_management_api.KeyManagementApi(api_client) app_key_id = \"app_key_id_example\" # str | The ID of the application key. body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( attributes=ApplicationKeyUpdateAttributes( name=\"Application Key for submitting metrics\", ), id=\"00112233-4455-6677-8899-aabbccddeeff\", type=ApplicationKeysType(\"application_keys\"), ), ) # ApplicationKeyUpdateRequest | # example passing only required values which don't have defaults set try: # Edit an application key owned by current user api_response = api_instance.update_current_user_application_key(app_key_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling KeyManagementApi->update_current_user_application_key: %s\\n\" % e)","title":"Example"},{"location":"v2/KeyManagementApi/#parameters_12","text":"Name Type Description Notes app_key_id str The ID of the application key. body ApplicationKeyUpdateRequest","title":"Parameters"},{"location":"v2/KeyManagementApi/#return-type_12","text":"ApplicationKeyResponse","title":"Return type"},{"location":"v2/KeyManagementApi/#authorization_12","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/KeyManagementApi/#http-request-headers_12","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/KeyManagementApi/#http-response-details_12","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/ListApplicationKeysResponse/","text":"ListApplicationKeysResponse Response for a list of application keys. Properties Name Type Description Notes data [PartialApplicationKey] Array of application keys. [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ListApplicationKeysResponse"},{"location":"v2/ListApplicationKeysResponse/#listapplicationkeysresponse","text":"Response for a list of application keys.","title":"ListApplicationKeysResponse"},{"location":"v2/ListApplicationKeysResponse/#properties","text":"Name Type Description Notes data [PartialApplicationKey] Array of application keys. [optional] included [ApplicationKeyResponseIncludedItem] Array of objects related to the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Log/","text":"Log Object description of a log after being processed and stored by Datadog. Properties Name Type Description Notes attributes LogAttributes [optional] id str Unique ID of the Log. [optional] type LogType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Log"},{"location":"v2/Log/#log","text":"Object description of a log after being processed and stored by Datadog.","title":"Log"},{"location":"v2/Log/#properties","text":"Name Type Description Notes attributes LogAttributes [optional] id str Unique ID of the Log. [optional] type LogType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogAttributes/","text":"LogAttributes JSON object containing all log attributes and their associated values. Properties Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 str Status of the message associated with your log. [optional] tags [str] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogAttributes"},{"location":"v2/LogAttributes/#logattributes","text":"JSON object containing all log attributes and their associated values.","title":"LogAttributes"},{"location":"v2/LogAttributes/#properties","text":"Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional] host str Name of the machine from where the logs are being sent. [optional] message str The message reserved attribute 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 str 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 str Status of the message associated with your log. [optional] tags [str] Array of tags associated with your log. [optional] timestamp datetime Timestamp of your log. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogType/","text":"LogType Type of the event. Properties Name Type Description Notes value str Type of the event. defaults to \"log\", must be one of [\"log\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogType"},{"location":"v2/LogType/#logtype","text":"Type of the event.","title":"LogType"},{"location":"v2/LogType/#properties","text":"Name Type Description Notes value str Type of the event. defaults to \"log\", must be one of [\"log\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucket/","text":"LogsAggregateBucket A bucket values Properties Name Type Description Notes by {str: (str,)} The key, value pairs for each group by [optional] computes {str: (LogsAggregateBucketValue,)} A map of the metric name -> value for regular compute or list of values for a timeseries [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucket"},{"location":"v2/LogsAggregateBucket/#logsaggregatebucket","text":"A bucket values","title":"LogsAggregateBucket"},{"location":"v2/LogsAggregateBucket/#properties","text":"Name Type Description Notes by {str: (str,)} The key, value pairs for each group by [optional] computes {str: (LogsAggregateBucketValue,)} A map of the metric name -> value for regular compute or list of values for a timeseries [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucketValue/","text":"LogsAggregateBucketValue A bucket value, can be either a timeseries or a single value Properties Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucketValue"},{"location":"v2/LogsAggregateBucketValue/#logsaggregatebucketvalue","text":"A bucket value, can be either a timeseries or a single value","title":"LogsAggregateBucketValue"},{"location":"v2/LogsAggregateBucketValue/#properties","text":"Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucketValueTimeseries/","text":"LogsAggregateBucketValueTimeseries A timeseries array Properties Name Type Description Notes value [LogsAggregateBucketValueTimeseriesPoint] A timeseries array [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucketValueTimeseries"},{"location":"v2/LogsAggregateBucketValueTimeseries/#logsaggregatebucketvaluetimeseries","text":"A timeseries array","title":"LogsAggregateBucketValueTimeseries"},{"location":"v2/LogsAggregateBucketValueTimeseries/#properties","text":"Name Type Description Notes value [LogsAggregateBucketValueTimeseriesPoint] A timeseries array [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateBucketValueTimeseriesPoint/","text":"LogsAggregateBucketValueTimeseriesPoint A timeseries point Properties Name Type Description Notes time str The time value for this point [optional] value float The value for this point [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateBucketValueTimeseriesPoint"},{"location":"v2/LogsAggregateBucketValueTimeseriesPoint/#logsaggregatebucketvaluetimeseriespoint","text":"A timeseries point","title":"LogsAggregateBucketValueTimeseriesPoint"},{"location":"v2/LogsAggregateBucketValueTimeseriesPoint/#properties","text":"Name Type Description Notes time str The time value for this point [optional] value float The value for this point [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateRequest/","text":"LogsAggregateRequest The object sent with the request to retrieve a list of logs from your organization. Properties Name Type Description Notes compute [LogsCompute] The list of metrics or timeseries to compute for the retrieved buckets. [optional] filter LogsQueryFilter [optional] group_by [LogsGroupBy] The rules for the group by [optional] options LogsQueryOptions [optional] page LogsAggregateRequestPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateRequest"},{"location":"v2/LogsAggregateRequest/#logsaggregaterequest","text":"The object sent with the request to retrieve a list of logs from your organization.","title":"LogsAggregateRequest"},{"location":"v2/LogsAggregateRequest/#properties","text":"Name Type Description Notes compute [LogsCompute] The list of metrics or timeseries to compute for the retrieved buckets. [optional] filter LogsQueryFilter [optional] group_by [LogsGroupBy] The rules for the group by [optional] options LogsQueryOptions [optional] page LogsAggregateRequestPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateRequestPage/","text":"LogsAggregateRequestPage Paging settings Properties Name Type Description Notes cursor str The returned paging point to use to get the next results [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateRequestPage"},{"location":"v2/LogsAggregateRequestPage/#logsaggregaterequestpage","text":"Paging settings","title":"LogsAggregateRequestPage"},{"location":"v2/LogsAggregateRequestPage/#properties","text":"Name Type Description Notes cursor str The returned paging point to use to get the next results [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateResponse/","text":"LogsAggregateResponse The response object for the logs aggregate API endpoint Properties Name Type Description Notes data LogsAggregateResponseData [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateResponse"},{"location":"v2/LogsAggregateResponse/#logsaggregateresponse","text":"The response object for the logs aggregate API endpoint","title":"LogsAggregateResponse"},{"location":"v2/LogsAggregateResponse/#properties","text":"Name Type Description Notes data LogsAggregateResponseData [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateResponseData/","text":"LogsAggregateResponseData The query results Properties Name Type Description Notes buckets [LogsAggregateBucket] The list of matching buckets, one item per bucket [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateResponseData"},{"location":"v2/LogsAggregateResponseData/#logsaggregateresponsedata","text":"The query results","title":"LogsAggregateResponseData"},{"location":"v2/LogsAggregateResponseData/#properties","text":"Name Type Description Notes buckets [LogsAggregateBucket] The list of matching buckets, one item per bucket [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateResponseStatus/","text":"LogsAggregateResponseStatus The status of the response Properties Name Type Description Notes value str The status of the response must be one of [\"done\", \"timeout\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateResponseStatus"},{"location":"v2/LogsAggregateResponseStatus/#logsaggregateresponsestatus","text":"The status of the response","title":"LogsAggregateResponseStatus"},{"location":"v2/LogsAggregateResponseStatus/#properties","text":"Name Type Description Notes value str The status of the response must be one of [\"done\", \"timeout\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateSort/","text":"LogsAggregateSort A sort rule Properties Name Type Description Notes aggregation LogsAggregationFunction [optional] metric str The metric to sort by (only used for `type=measure`) [optional] order LogsSortOrder [optional] type LogsAggregateSortType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateSort"},{"location":"v2/LogsAggregateSort/#logsaggregatesort","text":"A sort rule","title":"LogsAggregateSort"},{"location":"v2/LogsAggregateSort/#properties","text":"Name Type Description Notes aggregation LogsAggregationFunction [optional] metric str The metric to sort by (only used for `type=measure`) [optional] order LogsSortOrder [optional] type LogsAggregateSortType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregateSortType/","text":"LogsAggregateSortType The type of sorting algorithm Properties Name Type Description Notes value str The type of sorting algorithm defaults to \"alphabetical\", must be one of [\"alphabetical\", \"measure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregateSortType"},{"location":"v2/LogsAggregateSortType/#logsaggregatesorttype","text":"The type of sorting algorithm","title":"LogsAggregateSortType"},{"location":"v2/LogsAggregateSortType/#properties","text":"Name Type Description Notes value str The type of sorting algorithm defaults to \"alphabetical\", must be one of [\"alphabetical\", \"measure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsAggregationFunction/","text":"LogsAggregationFunction An aggregation function Properties Name Type Description Notes value str An aggregation function must be one of [\"count\", \"cardinality\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsAggregationFunction"},{"location":"v2/LogsAggregationFunction/#logsaggregationfunction","text":"An aggregation function","title":"LogsAggregationFunction"},{"location":"v2/LogsAggregationFunction/#properties","text":"Name Type Description Notes value str An aggregation function must be one of [\"count\", \"cardinality\", \"pc75\", \"pc90\", \"pc95\", \"pc98\", \"pc99\", \"sum\", \"min\", \"max\", \"avg\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsApi/","text":"datadog_api_client.v2.LogsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events list_logs POST /api/v2/logs/events/search Search logs list_logs_get GET /api/v2/logs/events Get a list of logs aggregate_logs LogsAggregateResponse aggregate_logs(body) Aggregate events The API endpoint to aggregate events into buckets and compute metrics and timeseries. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsAggregateRequest( compute=[ LogsCompute( aggregation=LogsAggregationFunction(\"pc90\"), interval=\"5m\", metric=\"@duration\", type=LogsComputeType(\"total\"), ), ], filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), group_by=[ LogsGroupBy( facet=\"host\", histogram=LogsGroupByHistogram( interval=10, max=100, min=50, ), limit=10, missing=LogsGroupByMissing(), sort=LogsAggregateSort( aggregation=LogsAggregationFunction(\"pc90\"), metric=\"@duration\", order=LogsSortOrder(\"asc\"), type=LogsAggregateSortType(\"alphabetical\"), ), total=LogsGroupByTotal(), ), ], options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsAggregateRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", ), ) # LogsAggregateRequest | # example passing only required values which don't have defaults set try: # Aggregate events api_response = api_instance.aggregate_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->aggregate_logs: %s\\n\" % e) Parameters Name Type Description Notes body LogsAggregateRequest Return type LogsAggregateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs LogsListResponse list_logs() Search logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to build complex logs filtering and search. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=LogsSort(\"timestamp\"), ) # LogsListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Search logs api_response = api_instance.list_logs(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e) Parameters Name Type Description Notes body LogsListRequest [optional] Return type LogsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_get LogsListResponse list_logs_get() Get a list of logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to see your latest logs. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) filter_query = \"@datacenter:us @role:db\" # str | Search query following logs syntax. (optional) filter_index = \"main\" # str | For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | Minimum timestamp for requested logs. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | Maximum timestamp for requested logs. (optional) sort = LogsSort(\"timestamp\") # LogsSort | Order of logs in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | List following results with a cursor provided in the previous query. (optional) page_limit = 25 # int | Maximum number of logs in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a list of logs api_response = api_instance.list_logs_get(filter_query=filter_query, filter_index=filter_index, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs_get: %s\\n\" % e) Parameters Name Type Description Notes filter_query str Search query following logs syntax. [optional] filter_index str For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes [optional] filter_from datetime Minimum timestamp for requested logs. [optional] filter_to datetime Maximum timestamp for requested logs. [optional] sort LogsSort Order of logs in results. [optional] page_cursor str List following results with a cursor provided in the previous query. [optional] page_limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10 Return type LogsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.LogsApi"},{"location":"v2/LogsApi/#datadog_api_clientv2logsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events list_logs POST /api/v2/logs/events/search Search logs list_logs_get GET /api/v2/logs/events Get a list of logs","title":"datadog_api_client.v2.LogsApi"},{"location":"v2/LogsApi/#aggregate_logs","text":"LogsAggregateResponse aggregate_logs(body) Aggregate events The API endpoint to aggregate events into buckets and compute metrics and timeseries.","title":"aggregate_logs"},{"location":"v2/LogsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsAggregateRequest( compute=[ LogsCompute( aggregation=LogsAggregationFunction(\"pc90\"), interval=\"5m\", metric=\"@duration\", type=LogsComputeType(\"total\"), ), ], filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), group_by=[ LogsGroupBy( facet=\"host\", histogram=LogsGroupByHistogram( interval=10, max=100, min=50, ), limit=10, missing=LogsGroupByMissing(), sort=LogsAggregateSort( aggregation=LogsAggregationFunction(\"pc90\"), metric=\"@duration\", order=LogsSortOrder(\"asc\"), type=LogsAggregateSortType(\"alphabetical\"), ), total=LogsGroupByTotal(), ), ], options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsAggregateRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", ), ) # LogsAggregateRequest | # example passing only required values which don't have defaults set try: # Aggregate events api_response = api_instance.aggregate_logs(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->aggregate_logs: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsApi/#parameters","text":"Name Type Description Notes body LogsAggregateRequest","title":"Parameters"},{"location":"v2/LogsApi/#return-type","text":"LogsAggregateResponse","title":"Return type"},{"location":"v2/LogsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsApi/#list_logs","text":"LogsListResponse list_logs() Search logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to build complex logs filtering and search. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives","title":"list_logs"},{"location":"v2/LogsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) body = LogsListRequest( filter=LogsQueryFilter( _from=\"now-15m\", indexes=[\"main\",\"web\"], query=\"service:web* AND @http.status_code:[200 TO 299]\", to=\"now\", ), options=LogsQueryOptions( time_offset=1, timezone=\"GMT\", ), page=LogsListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=LogsSort(\"timestamp\"), ) # LogsListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Search logs api_response = api_instance.list_logs(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsApi/#parameters_1","text":"Name Type Description Notes body LogsListRequest [optional]","title":"Parameters"},{"location":"v2/LogsApi/#return-type_1","text":"LogsListResponse","title":"Return type"},{"location":"v2/LogsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsApi/#list_logs_get","text":"LogsListResponse list_logs_get() Get a list of logs List endpoint returns logs that match a log search query. Results are paginated . Use this endpoint to see your latest logs. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Datadog Logs Archive documentation . [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives","title":"list_logs_get"},{"location":"v2/LogsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_api.LogsApi(api_client) filter_query = \"@datacenter:us @role:db\" # str | Search query following logs syntax. (optional) filter_index = \"main\" # str | For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | Minimum timestamp for requested logs. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | Maximum timestamp for requested logs. (optional) sort = LogsSort(\"timestamp\") # LogsSort | Order of logs in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | List following results with a cursor provided in the previous query. (optional) page_limit = 25 # int | Maximum number of logs in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a list of logs api_response = api_instance.list_logs_get(filter_query=filter_query, filter_index=filter_index, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsApi->list_logs_get: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsApi/#parameters_2","text":"Name Type Description Notes filter_query str Search query following logs syntax. [optional] filter_index str For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes [optional] filter_from datetime Minimum timestamp for requested logs. [optional] filter_to datetime Maximum timestamp for requested logs. [optional] sort LogsSort Order of logs in results. [optional] page_cursor str List following results with a cursor provided in the previous query. [optional] page_limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10","title":"Parameters"},{"location":"v2/LogsApi/#return-type_2","text":"LogsListResponse","title":"Return type"},{"location":"v2/LogsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchive/","text":"LogsArchive The logs archive. Properties Name Type Description Notes data LogsArchiveDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchive"},{"location":"v2/LogsArchive/#logsarchive","text":"The logs archive.","title":"LogsArchive"},{"location":"v2/LogsArchive/#properties","text":"Name Type Description Notes data LogsArchiveDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveAttributes/","text":"LogsArchiveAttributes The attributes associated with the archive. Properties Name Type Description Notes destination LogsArchiveDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] state LogsArchiveState [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveAttributes"},{"location":"v2/LogsArchiveAttributes/#logsarchiveattributes","text":"The attributes associated with the archive.","title":"LogsArchiveAttributes"},{"location":"v2/LogsArchiveAttributes/#properties","text":"Name Type Description Notes destination LogsArchiveDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] state LogsArchiveState [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequest/","text":"LogsArchiveCreateRequest The logs archive. Properties Name Type Description Notes data LogsArchiveCreateRequestDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequest"},{"location":"v2/LogsArchiveCreateRequest/#logsarchivecreaterequest","text":"The logs archive.","title":"LogsArchiveCreateRequest"},{"location":"v2/LogsArchiveCreateRequest/#properties","text":"Name Type Description Notes data LogsArchiveCreateRequestDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequestAttributes/","text":"LogsArchiveCreateRequestAttributes The attributes associated with the archive. Properties Name Type Description Notes destination LogsArchiveCreateRequestDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequestAttributes"},{"location":"v2/LogsArchiveCreateRequestAttributes/#logsarchivecreaterequestattributes","text":"The attributes associated with the archive.","title":"LogsArchiveCreateRequestAttributes"},{"location":"v2/LogsArchiveCreateRequestAttributes/#properties","text":"Name Type Description Notes destination LogsArchiveCreateRequestDestination name str The archive name. query str The archive query/filter. Logs matching this query are included in the archive. include_tags bool 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] if omitted the server will use the default value of False rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequestDefinition/","text":"LogsArchiveCreateRequestDefinition The definition of an archive. Properties Name Type Description Notes type str The type of the resource. The value should always be archives. defaults to \"archives\" attributes LogsArchiveCreateRequestAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequestDefinition"},{"location":"v2/LogsArchiveCreateRequestDefinition/#logsarchivecreaterequestdefinition","text":"The definition of an archive.","title":"LogsArchiveCreateRequestDefinition"},{"location":"v2/LogsArchiveCreateRequestDefinition/#properties","text":"Name Type Description Notes type str The type of the resource. The value should always be archives. defaults to \"archives\" attributes LogsArchiveCreateRequestAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveCreateRequestDestination/","text":"LogsArchiveCreateRequestDestination An archive's destination. Properties Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveCreateRequestDestination"},{"location":"v2/LogsArchiveCreateRequestDestination/#logsarchivecreaterequestdestination","text":"An archive's destination.","title":"LogsArchiveCreateRequestDestination"},{"location":"v2/LogsArchiveCreateRequestDestination/#properties","text":"Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDefinition/","text":"LogsArchiveDefinition The definition of an archive. Properties Name Type Description Notes type str The type of the resource. The value should always be archives. [readonly] defaults to \"archives\" attributes LogsArchiveAttributes [optional] id str The archive ID. optional [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDefinition"},{"location":"v2/LogsArchiveDefinition/#logsarchivedefinition","text":"The definition of an archive.","title":"LogsArchiveDefinition"},{"location":"v2/LogsArchiveDefinition/#properties","text":"Name Type Description Notes type str The type of the resource. The value should always be archives. [readonly] defaults to \"archives\" attributes LogsArchiveAttributes [optional] id str The archive ID. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestination/","text":"LogsArchiveDestination An archive's destination. Properties Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestination"},{"location":"v2/LogsArchiveDestination/#logsarchivedestination","text":"An archive's destination.","title":"LogsArchiveDestination"},{"location":"v2/LogsArchiveDestination/#properties","text":"Name Type Description Notes path str The archive path. [optional] region str The region where the archive will be stored. [optional] container str The container where the archive will be stored. [optional] integration LogsArchiveIntegrationS3 [optional] storage_account str The associated storage account. [optional] type LogsArchiveDestinationS3Type [optional] bucket str The bucket where the archive will be stored. [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationAzure/","text":"LogsArchiveDestinationAzure The Azure archive destination. Properties Name Type Description Notes container str The container where the archive will be stored. integration LogsArchiveIntegrationAzure storage_account str The associated storage account. type LogsArchiveDestinationAzureType path str The archive path. [optional] region str The region where the archive will be stored. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationAzure"},{"location":"v2/LogsArchiveDestinationAzure/#logsarchivedestinationazure","text":"The Azure archive destination.","title":"LogsArchiveDestinationAzure"},{"location":"v2/LogsArchiveDestinationAzure/#properties","text":"Name Type Description Notes container str The container where the archive will be stored. integration LogsArchiveIntegrationAzure storage_account str The associated storage account. type LogsArchiveDestinationAzureType path str The archive path. [optional] region str The region where the archive will be stored. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationAzureType/","text":"LogsArchiveDestinationAzureType Type of the Azure archive destination. Properties Name Type Description Notes value str Type of the Azure archive destination. defaults to \"azure\", must be one of [\"azure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationAzureType"},{"location":"v2/LogsArchiveDestinationAzureType/#logsarchivedestinationazuretype","text":"Type of the Azure archive destination.","title":"LogsArchiveDestinationAzureType"},{"location":"v2/LogsArchiveDestinationAzureType/#properties","text":"Name Type Description Notes value str Type of the Azure archive destination. defaults to \"azure\", must be one of [\"azure\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationGCS/","text":"LogsArchiveDestinationGCS The GCS archive destination. Properties Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationGCS type LogsArchiveDestinationGCSType path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationGCS"},{"location":"v2/LogsArchiveDestinationGCS/#logsarchivedestinationgcs","text":"The GCS archive destination.","title":"LogsArchiveDestinationGCS"},{"location":"v2/LogsArchiveDestinationGCS/#properties","text":"Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationGCS type LogsArchiveDestinationGCSType path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationGCSType/","text":"LogsArchiveDestinationGCSType Type of the GCS archive destination. Properties Name Type Description Notes value str Type of the GCS archive destination. defaults to \"gcs\", must be one of [\"gcs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationGCSType"},{"location":"v2/LogsArchiveDestinationGCSType/#logsarchivedestinationgcstype","text":"Type of the GCS archive destination.","title":"LogsArchiveDestinationGCSType"},{"location":"v2/LogsArchiveDestinationGCSType/#properties","text":"Name Type Description Notes value str Type of the GCS archive destination. defaults to \"gcs\", must be one of [\"gcs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationS3/","text":"LogsArchiveDestinationS3 The S3 archive destination. Properties Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationS3 type LogsArchiveDestinationS3Type path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationS3"},{"location":"v2/LogsArchiveDestinationS3/#logsarchivedestinations3","text":"The S3 archive destination.","title":"LogsArchiveDestinationS3"},{"location":"v2/LogsArchiveDestinationS3/#properties","text":"Name Type Description Notes bucket str The bucket where the archive will be stored. integration LogsArchiveIntegrationS3 type LogsArchiveDestinationS3Type path str The archive path. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveDestinationS3Type/","text":"LogsArchiveDestinationS3Type Type of the S3 archive destination. Properties Name Type Description Notes value str Type of the S3 archive destination. defaults to \"s3\", must be one of [\"s3\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveDestinationS3Type"},{"location":"v2/LogsArchiveDestinationS3Type/#logsarchivedestinations3type","text":"Type of the S3 archive destination.","title":"LogsArchiveDestinationS3Type"},{"location":"v2/LogsArchiveDestinationS3Type/#properties","text":"Name Type Description Notes value str Type of the S3 archive destination. defaults to \"s3\", must be one of [\"s3\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveIntegrationAzure/","text":"LogsArchiveIntegrationAzure The Azure archive's integration destination. Properties Name Type Description Notes client_id str A client ID. tenant_id str A tenant ID. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveIntegrationAzure"},{"location":"v2/LogsArchiveIntegrationAzure/#logsarchiveintegrationazure","text":"The Azure archive's integration destination.","title":"LogsArchiveIntegrationAzure"},{"location":"v2/LogsArchiveIntegrationAzure/#properties","text":"Name Type Description Notes client_id str A client ID. tenant_id str A tenant ID. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveIntegrationGCS/","text":"LogsArchiveIntegrationGCS The GCS archive's integration destination. Properties Name Type Description Notes client_email str A client email. project_id str A project ID. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveIntegrationGCS"},{"location":"v2/LogsArchiveIntegrationGCS/#logsarchiveintegrationgcs","text":"The GCS archive's integration destination.","title":"LogsArchiveIntegrationGCS"},{"location":"v2/LogsArchiveIntegrationGCS/#properties","text":"Name Type Description Notes client_email str A client email. project_id str A project ID. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveIntegrationS3/","text":"LogsArchiveIntegrationS3 The S3 Archive's integration destination. Properties Name Type Description Notes account_id str The account ID for the integration. role_name str The path of the integration. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveIntegrationS3"},{"location":"v2/LogsArchiveIntegrationS3/#logsarchiveintegrations3","text":"The S3 Archive's integration destination.","title":"LogsArchiveIntegrationS3"},{"location":"v2/LogsArchiveIntegrationS3/#properties","text":"Name Type Description Notes account_id str The account ID for the integration. role_name str The path of the integration. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrder/","text":"LogsArchiveOrder A ordered list of archive IDs. Properties Name Type Description Notes data LogsArchiveOrderDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrder"},{"location":"v2/LogsArchiveOrder/#logsarchiveorder","text":"A ordered list of archive IDs.","title":"LogsArchiveOrder"},{"location":"v2/LogsArchiveOrder/#properties","text":"Name Type Description Notes data LogsArchiveOrderDefinition [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrderAttributes/","text":"LogsArchiveOrderAttributes The attributes associated with the archive order. Properties Name Type Description Notes archive_ids [str] An ordered array of `` strings, the order of archive IDs in the array define the overall archives order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrderAttributes"},{"location":"v2/LogsArchiveOrderAttributes/#logsarchiveorderattributes","text":"The attributes associated with the archive order.","title":"LogsArchiveOrderAttributes"},{"location":"v2/LogsArchiveOrderAttributes/#properties","text":"Name Type Description Notes archive_ids [str] An ordered array of `` strings, the order of archive IDs in the array define the overall archives order for Datadog. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrderDefinition/","text":"LogsArchiveOrderDefinition The definition of an archive order. Properties Name Type Description Notes attributes LogsArchiveOrderAttributes type LogsArchiveOrderDefinitionType [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrderDefinition"},{"location":"v2/LogsArchiveOrderDefinition/#logsarchiveorderdefinition","text":"The definition of an archive order.","title":"LogsArchiveOrderDefinition"},{"location":"v2/LogsArchiveOrderDefinition/#properties","text":"Name Type Description Notes attributes LogsArchiveOrderAttributes type LogsArchiveOrderDefinitionType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveOrderDefinitionType/","text":"LogsArchiveOrderDefinitionType Type of the archive order definition. Properties Name Type Description Notes value str Type of the archive order definition. defaults to \"archive_order\", must be one of [\"archive_order\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveOrderDefinitionType"},{"location":"v2/LogsArchiveOrderDefinitionType/#logsarchiveorderdefinitiontype","text":"Type of the archive order definition.","title":"LogsArchiveOrderDefinitionType"},{"location":"v2/LogsArchiveOrderDefinitionType/#properties","text":"Name Type Description Notes value str Type of the archive order definition. defaults to \"archive_order\", must be one of [\"archive_order\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchiveState/","text":"LogsArchiveState The state of the archive. Properties Name Type Description Notes value str The state of the archive. must be one of [\"UNKNOWN\", \"WORKING\", \"FAILING\", \"WORKING_AUTH_LEGACY\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchiveState"},{"location":"v2/LogsArchiveState/#logsarchivestate","text":"The state of the archive.","title":"LogsArchiveState"},{"location":"v2/LogsArchiveState/#properties","text":"Name Type Description Notes value str The state of the archive. must be one of [\"UNKNOWN\", \"WORKING\", \"FAILING\", \"WORKING_AUTH_LEGACY\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchives/","text":"LogsArchives The available archives. Properties Name Type Description Notes data [LogsArchiveDefinition] A list of archives. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsArchives"},{"location":"v2/LogsArchives/#logsarchives","text":"The available archives.","title":"LogsArchives"},{"location":"v2/LogsArchives/#properties","text":"Name Type Description Notes data [LogsArchiveDefinition] A list of archives. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsArchivesApi/","text":"datadog_api_client.v2.LogsArchivesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive create_logs_archive POST /api/v2/logs/config/archives Create an archive delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive list_logs_archives GET /api/v2/logs/config/archives Get all archives remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order add_read_role_to_archive add_read_role_to_archive(archive_id, body) Grant role to an archive Adds a read role to an archive. ( Roles API ) Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Grant role to an archive api_instance.add_read_role_to_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->add_read_role_to_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_logs_archive LogsArchive create_logs_archive(body) Create an archive Create an archive in your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | The definition of the new archive. # example passing only required values which don't have defaults set try: # Create an archive api_response = api_instance.create_logs_archive(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->create_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes body LogsArchiveCreateRequest The definition of the new archive. Return type LogsArchive Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_logs_archive delete_logs_archive(archive_id) Delete an archive Delete a given archive from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Delete an archive api_instance.delete_logs_archive(archive_id) except ApiException as e: print(\"Exception when calling LogsArchivesApi->delete_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_archive LogsArchive get_logs_archive(archive_id) Get an archive Get a specific archive from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Get an archive api_response = api_instance.get_logs_archive(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. Return type LogsArchive Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_archive_order LogsArchiveOrder get_logs_archive_order() Get archive order Get the current order of your archives. This endpoint takes no JSON arguments. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get archive order api_response = api_instance.get_logs_archive_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive_order: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsArchiveOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_archive_read_roles RolesResponse list_archive_read_roles(archive_id) List read roles for an archive Returns all read roles a given archive is restricted to. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # List read roles for an archive api_response = api_instance.list_archive_read_roles(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_archive_read_roles: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. Return type RolesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_archives LogsArchives list_logs_archives() Get all archives Get the list of configured logs archives with their definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all archives api_response = api_instance.list_logs_archives() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_logs_archives: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsArchives Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_role_from_archive remove_role_from_archive(archive_id, body) Revoke role from an archive Removes a role from an archive. ( Roles API ) Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Revoke role from an archive api_instance.remove_role_from_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->remove_role_from_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_archive LogsArchive update_logs_archive(archive_id, body) Update an archive Update a given archive configuration. Note : Using this method updates your archive configuration by replacing your current configuration with the new one sent to your Datadog organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | New definition of the archive. # example passing only required values which don't have defaults set try: # Update an archive api_response = api_instance.update_logs_archive(archive_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive: %s\\n\" % e) Parameters Name Type Description Notes archive_id str The ID of the archive. body LogsArchiveCreateRequest New definition of the archive. Return type LogsArchive Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_archive_order LogsArchiveOrder update_logs_archive_order(body) Update archive order Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. Note : Using the PUT method updates your archive's order by replacing the current order with the new one. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveOrder( data=LogsArchiveOrderDefinition( attributes=LogsArchiveOrderAttributes( archive_ids=[\"a2zcMylnM4OCHpYusxIi1g\",\"a2zcMylnM4OCHpYusxIi2g\",\"a2zcMylnM4OCHpYusxIi3g\"], ), type=LogsArchiveOrderDefinitionType(\"archive_order\"), ), ) # LogsArchiveOrder | An object containing the new ordered list of archive IDs. # example passing only required values which don't have defaults set try: # Update archive order api_response = api_instance.update_logs_archive_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive_order: %s\\n\" % e) Parameters Name Type Description Notes body LogsArchiveOrder An object containing the new ordered list of archive IDs. Return type LogsArchiveOrder Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.LogsArchivesApi"},{"location":"v2/LogsArchivesApi/#datadog_api_clientv2logsarchivesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive create_logs_archive POST /api/v2/logs/config/archives Create an archive delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive list_logs_archives GET /api/v2/logs/config/archives Get all archives remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order","title":"datadog_api_client.v2.LogsArchivesApi"},{"location":"v2/LogsArchivesApi/#add_read_role_to_archive","text":"add_read_role_to_archive(archive_id, body) Grant role to an archive Adds a read role to an archive. ( Roles API )","title":"add_read_role_to_archive"},{"location":"v2/LogsArchivesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Grant role to an archive api_instance.add_read_role_to_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->add_read_role_to_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters","text":"Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details","text":"Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#create_logs_archive","text":"LogsArchive create_logs_archive(body) Create an archive Create an archive in your organization.","title":"create_logs_archive"},{"location":"v2/LogsArchivesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | The definition of the new archive. # example passing only required values which don't have defaults set try: # Create an archive api_response = api_instance.create_logs_archive(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->create_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_1","text":"Name Type Description Notes body LogsArchiveCreateRequest The definition of the new archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_1","text":"LogsArchive","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#delete_logs_archive","text":"delete_logs_archive(archive_id) Delete an archive Delete a given archive from your organization.","title":"delete_logs_archive"},{"location":"v2/LogsArchivesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Delete an archive api_instance.delete_logs_archive(archive_id) except ApiException as e: print(\"Exception when calling LogsArchivesApi->delete_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_2","text":"Name Type Description Notes archive_id str The ID of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_2","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_2","text":"Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#get_logs_archive","text":"LogsArchive get_logs_archive(archive_id) Get an archive Get a specific archive from your organization.","title":"get_logs_archive"},{"location":"v2/LogsArchivesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # Get an archive api_response = api_instance.get_logs_archive(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_3","text":"Name Type Description Notes archive_id str The ID of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_3","text":"LogsArchive","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#get_logs_archive_order","text":"LogsArchiveOrder get_logs_archive_order() Get archive order Get the current order of your archives. This endpoint takes no JSON arguments.","title":"get_logs_archive_order"},{"location":"v2/LogsArchivesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get archive order api_response = api_instance.get_logs_archive_order() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->get_logs_archive_order: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_4","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_4","text":"LogsArchiveOrder","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#list_archive_read_roles","text":"RolesResponse list_archive_read_roles(archive_id) List read roles for an archive Returns all read roles a given archive is restricted to.","title":"list_archive_read_roles"},{"location":"v2/LogsArchivesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. # example passing only required values which don't have defaults set try: # List read roles for an archive api_response = api_instance.list_archive_read_roles(archive_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_archive_read_roles: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_5","text":"Name Type Description Notes archive_id str The ID of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_5","text":"RolesResponse","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#list_logs_archives","text":"LogsArchives list_logs_archives() Get all archives Get the list of configured logs archives with their definitions.","title":"list_logs_archives"},{"location":"v2/LogsArchivesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all archives api_response = api_instance.list_logs_archives() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->list_logs_archives: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_6","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_6","text":"LogsArchives","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Forbidden - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#remove_role_from_archive","text":"remove_role_from_archive(archive_id, body) Revoke role from an archive Removes a role from an archive. ( Roles API )","title":"remove_role_from_archive"},{"location":"v2/LogsArchivesApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = RelationshipToRole( data=RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ) # RelationshipToRole | # example passing only required values which don't have defaults set try: # Revoke role from an archive api_instance.remove_role_from_archive(archive_id, body) except ApiException as e: print(\"Exception when calling LogsArchivesApi->remove_role_from_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_7","text":"Name Type Description Notes archive_id str The ID of the archive. body RelationshipToRole","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_7","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_7","text":"Status code Description Response headers 204 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#update_logs_archive","text":"LogsArchive update_logs_archive(archive_id, body) Update an archive Update a given archive configuration. Note : Using this method updates your archive configuration by replacing your current configuration with the new one sent to your Datadog organization.","title":"update_logs_archive"},{"location":"v2/LogsArchivesApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) archive_id = \"archive_id_example\" # str | The ID of the archive. body = LogsArchiveCreateRequest( data=LogsArchiveCreateRequestDefinition( attributes=LogsArchiveCreateRequestAttributes( destination=LogsArchiveCreateRequestDestination(), include_tags=False, name=\"Nginx Archive\", query=\"source:nginx\", rehydration_tags=[\"team:intake\",\"team:app\"], ), type=\"archives\", ), ) # LogsArchiveCreateRequest | New definition of the archive. # example passing only required values which don't have defaults set try: # Update an archive api_response = api_instance.update_logs_archive(archive_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_8","text":"Name Type Description Notes archive_id str The ID of the archive. body LogsArchiveCreateRequest New definition of the archive.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_8","text":"LogsArchive","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsArchivesApi/#update_logs_archive_order","text":"LogsArchiveOrder update_logs_archive_order(body) Update archive order Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. Note : Using the PUT method updates your archive's order by replacing the current order with the new one.","title":"update_logs_archive_order"},{"location":"v2/LogsArchivesApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_archives_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_archives_api.LogsArchivesApi(api_client) body = LogsArchiveOrder( data=LogsArchiveOrderDefinition( attributes=LogsArchiveOrderAttributes( archive_ids=[\"a2zcMylnM4OCHpYusxIi1g\",\"a2zcMylnM4OCHpYusxIi2g\",\"a2zcMylnM4OCHpYusxIi3g\"], ), type=LogsArchiveOrderDefinitionType(\"archive_order\"), ), ) # LogsArchiveOrder | An object containing the new ordered list of archive IDs. # example passing only required values which don't have defaults set try: # Update archive order api_response = api_instance.update_logs_archive_order(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsArchivesApi->update_logs_archive_order: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsArchivesApi/#parameters_9","text":"Name Type Description Notes body LogsArchiveOrder An object containing the new ordered list of archive IDs.","title":"Parameters"},{"location":"v2/LogsArchivesApi/#return-type_9","text":"LogsArchiveOrder","title":"Return type"},{"location":"v2/LogsArchivesApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsArchivesApi/#http-request-headers_9","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsArchivesApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsCompute/","text":"LogsCompute A compute rule to compute metrics or timeseries Properties Name Type Description Notes aggregation LogsAggregationFunction interval str The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points [optional] metric str The metric to use [optional] type LogsComputeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsCompute"},{"location":"v2/LogsCompute/#logscompute","text":"A compute rule to compute metrics or timeseries","title":"LogsCompute"},{"location":"v2/LogsCompute/#properties","text":"Name Type Description Notes aggregation LogsAggregationFunction interval str The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points [optional] metric str The metric to use [optional] type LogsComputeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsComputeType/","text":"LogsComputeType The type of compute Properties Name Type Description Notes value str The type of compute defaults to \"total\", must be one of [\"timeseries\", \"total\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsComputeType"},{"location":"v2/LogsComputeType/#logscomputetype","text":"The type of compute","title":"LogsComputeType"},{"location":"v2/LogsComputeType/#properties","text":"Name Type Description Notes value str The type of compute defaults to \"total\", must be one of [\"timeseries\", \"total\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupBy/","text":"LogsGroupBy A group by rule Properties Name Type Description Notes facet str The name of the facet to use (required) histogram LogsGroupByHistogram [optional] limit int The maximum buckets to return for this group by [optional] if omitted the server will use the default value of 10 missing LogsGroupByMissing [optional] sort LogsAggregateSort [optional] total LogsGroupByTotal [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupBy"},{"location":"v2/LogsGroupBy/#logsgroupby","text":"A group by rule","title":"LogsGroupBy"},{"location":"v2/LogsGroupBy/#properties","text":"Name Type Description Notes facet str The name of the facet to use (required) histogram LogsGroupByHistogram [optional] limit int The maximum buckets to return for this group by [optional] if omitted the server will use the default value of 10 missing LogsGroupByMissing [optional] sort LogsAggregateSort [optional] total LogsGroupByTotal [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupByHistogram/","text":"LogsGroupByHistogram Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval. 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) [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupByHistogram"},{"location":"v2/LogsGroupByHistogram/#logsgroupbyhistogram","text":"Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.","title":"LogsGroupByHistogram"},{"location":"v2/LogsGroupByHistogram/#properties","text":"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) [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupByMissing/","text":"LogsGroupByMissing The value to use for logs that don't have the facet used to group by Properties Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupByMissing"},{"location":"v2/LogsGroupByMissing/#logsgroupbymissing","text":"The value to use for logs that don't have the facet used to group by","title":"LogsGroupByMissing"},{"location":"v2/LogsGroupByMissing/#properties","text":"Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsGroupByTotal/","text":"LogsGroupByTotal A resulting object to put the given computes in over all the matching records. Properties Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsGroupByTotal"},{"location":"v2/LogsGroupByTotal/#logsgroupbytotal","text":"A resulting object to put the given computes in over all the matching records.","title":"LogsGroupByTotal"},{"location":"v2/LogsGroupByTotal/#properties","text":"Name Type Description Notes any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListRequest/","text":"LogsListRequest The request for a logs list. Properties Name Type Description Notes filter LogsQueryFilter [optional] options LogsQueryOptions [optional] page LogsListRequestPage [optional] sort LogsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequest"},{"location":"v2/LogsListRequest/#logslistrequest","text":"The request for a logs list.","title":"LogsListRequest"},{"location":"v2/LogsListRequest/#properties","text":"Name Type Description Notes filter LogsQueryFilter [optional] options LogsQueryOptions [optional] page LogsListRequestPage [optional] sort LogsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListRequestPage/","text":"LogsListRequestPage Paging attributes for listing logs. Properties Name Type Description Notes cursor str List following results with a cursor provided in the previous query. [optional] limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"LogsListRequestPage"},{"location":"v2/LogsListRequestPage/#logslistrequestpage","text":"Paging attributes for listing logs.","title":"LogsListRequestPage"},{"location":"v2/LogsListRequestPage/#properties","text":"Name Type Description Notes cursor str List following results with a cursor provided in the previous query. [optional] limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListResponse/","text":"LogsListResponse Response object with all logs matching the request and pagination information. Properties Name Type Description Notes data [Log] Array of logs matching the request. [optional] links LogsListResponseLinks [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListResponse"},{"location":"v2/LogsListResponse/#logslistresponse","text":"Response object with all logs matching the request and pagination information.","title":"LogsListResponse"},{"location":"v2/LogsListResponse/#properties","text":"Name Type Description Notes data [Log] Array of logs matching the request. [optional] links LogsListResponseLinks [optional] meta LogsResponseMetadata [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsListResponseLinks/","text":"LogsListResponseLinks Links attributes. Properties Name Type Description Notes next str Link for the next set of results. Note that the request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsListResponseLinks"},{"location":"v2/LogsListResponseLinks/#logslistresponselinks","text":"Links attributes.","title":"LogsListResponseLinks"},{"location":"v2/LogsListResponseLinks/#properties","text":"Name Type Description Notes next str Link for the next set of results. Note that the request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCompute/","text":"LogsMetricCompute The compute rule to compute the log-based metric. Properties Name Type Description Notes aggregation_type LogsMetricComputeAggregationType path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCompute"},{"location":"v2/LogsMetricCompute/#logsmetriccompute","text":"The compute rule to compute the log-based metric.","title":"LogsMetricCompute"},{"location":"v2/LogsMetricCompute/#properties","text":"Name Type Description Notes aggregation_type LogsMetricComputeAggregationType path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricComputeAggregationType/","text":"LogsMetricComputeAggregationType The type of aggregation to use. Properties Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricComputeAggregationType"},{"location":"v2/LogsMetricComputeAggregationType/#logsmetriccomputeaggregationtype","text":"The type of aggregation to use.","title":"LogsMetricComputeAggregationType"},{"location":"v2/LogsMetricComputeAggregationType/#properties","text":"Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCreateAttributes/","text":"LogsMetricCreateAttributes The object describing the Datadog log-based metric to create. Properties Name Type Description Notes compute LogsMetricCompute filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCreateAttributes"},{"location":"v2/LogsMetricCreateAttributes/#logsmetriccreateattributes","text":"The object describing the Datadog log-based metric to create.","title":"LogsMetricCreateAttributes"},{"location":"v2/LogsMetricCreateAttributes/#properties","text":"Name Type Description Notes compute LogsMetricCompute filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCreateData/","text":"LogsMetricCreateData The new log-based metric properties. Properties Name Type Description Notes attributes LogsMetricCreateAttributes id str The name of the log-based metric. type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCreateData"},{"location":"v2/LogsMetricCreateData/#logsmetriccreatedata","text":"The new log-based metric properties.","title":"LogsMetricCreateData"},{"location":"v2/LogsMetricCreateData/#properties","text":"Name Type Description Notes attributes LogsMetricCreateAttributes id str The name of the log-based metric. type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricCreateRequest/","text":"LogsMetricCreateRequest The new log-based metric body. Properties Name Type Description Notes data LogsMetricCreateData [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricCreateRequest"},{"location":"v2/LogsMetricCreateRequest/#logsmetriccreaterequest","text":"The new log-based metric body.","title":"LogsMetricCreateRequest"},{"location":"v2/LogsMetricCreateRequest/#properties","text":"Name Type Description Notes data LogsMetricCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricFilter/","text":"LogsMetricFilter The log-based metric filter. Logs matching this filter will be aggregated in this metric. Properties Name Type Description Notes query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricFilter"},{"location":"v2/LogsMetricFilter/#logsmetricfilter","text":"The log-based metric filter. Logs matching this filter will be aggregated in this metric.","title":"LogsMetricFilter"},{"location":"v2/LogsMetricFilter/#properties","text":"Name Type Description Notes query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricGroupBy/","text":"LogsMetricGroupBy A group by rule. Properties Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricGroupBy"},{"location":"v2/LogsMetricGroupBy/#logsmetricgroupby","text":"A group by rule.","title":"LogsMetricGroupBy"},{"location":"v2/LogsMetricGroupBy/#properties","text":"Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponse/","text":"LogsMetricResponse The log-based metric object. Properties Name Type Description Notes data LogsMetricResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponse"},{"location":"v2/LogsMetricResponse/#logsmetricresponse","text":"The log-based metric object.","title":"LogsMetricResponse"},{"location":"v2/LogsMetricResponse/#properties","text":"Name Type Description Notes data LogsMetricResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseAttributes/","text":"LogsMetricResponseAttributes The object describing a Datadog log-based metric. Properties Name Type Description Notes compute LogsMetricResponseCompute [optional] filter LogsMetricResponseFilter [optional] group_by [LogsMetricResponseGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseAttributes"},{"location":"v2/LogsMetricResponseAttributes/#logsmetricresponseattributes","text":"The object describing a Datadog log-based metric.","title":"LogsMetricResponseAttributes"},{"location":"v2/LogsMetricResponseAttributes/#properties","text":"Name Type Description Notes compute LogsMetricResponseCompute [optional] filter LogsMetricResponseFilter [optional] group_by [LogsMetricResponseGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseCompute/","text":"LogsMetricResponseCompute The compute rule to compute the log-based metric. Properties Name Type Description Notes aggregation_type LogsMetricResponseComputeAggregationType [optional] path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseCompute"},{"location":"v2/LogsMetricResponseCompute/#logsmetricresponsecompute","text":"The compute rule to compute the log-based metric.","title":"LogsMetricResponseCompute"},{"location":"v2/LogsMetricResponseCompute/#properties","text":"Name Type Description Notes aggregation_type LogsMetricResponseComputeAggregationType [optional] path str The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \\\"distribution\\\"). [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseComputeAggregationType/","text":"LogsMetricResponseComputeAggregationType The type of aggregation to use. Properties Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseComputeAggregationType"},{"location":"v2/LogsMetricResponseComputeAggregationType/#logsmetricresponsecomputeaggregationtype","text":"The type of aggregation to use.","title":"LogsMetricResponseComputeAggregationType"},{"location":"v2/LogsMetricResponseComputeAggregationType/#properties","text":"Name Type Description Notes value str The type of aggregation to use. must be one of [\"count\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseData/","text":"LogsMetricResponseData The log-based metric properties. Properties Name Type Description Notes attributes LogsMetricResponseAttributes [optional] id str The name of the log-based metric. [optional] type LogsMetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseData"},{"location":"v2/LogsMetricResponseData/#logsmetricresponsedata","text":"The log-based metric properties.","title":"LogsMetricResponseData"},{"location":"v2/LogsMetricResponseData/#properties","text":"Name Type Description Notes attributes LogsMetricResponseAttributes [optional] id str The name of the log-based metric. [optional] type LogsMetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseFilter/","text":"LogsMetricResponseFilter The log-based metric filter. Logs matching this filter will be aggregated in this metric. Properties Name Type Description Notes query str The search query - following the log search syntax. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseFilter"},{"location":"v2/LogsMetricResponseFilter/#logsmetricresponsefilter","text":"The log-based metric filter. Logs matching this filter will be aggregated in this metric.","title":"LogsMetricResponseFilter"},{"location":"v2/LogsMetricResponseFilter/#properties","text":"Name Type Description Notes query str The search query - following the log search syntax. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricResponseGroupBy/","text":"LogsMetricResponseGroupBy A group by rule. Properties Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. [optional] tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricResponseGroupBy"},{"location":"v2/LogsMetricResponseGroupBy/#logsmetricresponsegroupby","text":"A group by rule.","title":"LogsMetricResponseGroupBy"},{"location":"v2/LogsMetricResponseGroupBy/#properties","text":"Name Type Description Notes path str The path to the value the log-based metric will be aggregated over. [optional] tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricType/","text":"LogsMetricType The type of the resource. The value should always be logs_metrics. Properties Name Type Description Notes value str The type of the resource. The value should always be logs_metrics. defaults to \"logs_metrics\", must be one of [\"logs_metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricType"},{"location":"v2/LogsMetricType/#logsmetrictype","text":"The type of the resource. The value should always be logs_metrics.","title":"LogsMetricType"},{"location":"v2/LogsMetricType/#properties","text":"Name Type Description Notes value str The type of the resource. The value should always be logs_metrics. defaults to \"logs_metrics\", must be one of [\"logs_metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricUpdateAttributes/","text":"LogsMetricUpdateAttributes The log-based metric properties that will be updated. Properties Name Type Description Notes filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricUpdateAttributes"},{"location":"v2/LogsMetricUpdateAttributes/#logsmetricupdateattributes","text":"The log-based metric properties that will be updated.","title":"LogsMetricUpdateAttributes"},{"location":"v2/LogsMetricUpdateAttributes/#properties","text":"Name Type Description Notes filter LogsMetricFilter [optional] group_by [LogsMetricGroupBy] The rules for the group by. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricUpdateData/","text":"LogsMetricUpdateData The new log-based metric properties. Properties Name Type Description Notes attributes LogsMetricUpdateAttributes type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricUpdateData"},{"location":"v2/LogsMetricUpdateData/#logsmetricupdatedata","text":"The new log-based metric properties.","title":"LogsMetricUpdateData"},{"location":"v2/LogsMetricUpdateData/#properties","text":"Name Type Description Notes attributes LogsMetricUpdateAttributes type LogsMetricType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricUpdateRequest/","text":"LogsMetricUpdateRequest The new log-based metric body. Properties Name Type Description Notes data LogsMetricUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricUpdateRequest"},{"location":"v2/LogsMetricUpdateRequest/#logsmetricupdaterequest","text":"The new log-based metric body.","title":"LogsMetricUpdateRequest"},{"location":"v2/LogsMetricUpdateRequest/#properties","text":"Name Type Description Notes data LogsMetricUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsMetricsApi/","text":"datadog_api_client.v2.LogsMetricsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric create_logs_metric LogsMetricResponse create_logs_metric(body) Create a log-based metric Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) body = LogsMetricCreateRequest( data=LogsMetricCreateData( attributes=LogsMetricCreateAttributes( compute=LogsMetricCompute( aggregation_type=LogsMetricComputeAggregationType(\"distribution\"), path=\"@duration\", ), filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), id=\"logs.page.load.count\", type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricCreateRequest | The definition of the new log-based metric. # example passing only required values which don't have defaults set try: # Create a log-based metric api_response = api_instance.create_logs_metric(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->create_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes body LogsMetricCreateRequest The definition of the new log-based metric. Return type LogsMetricResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 409 Conflict - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_logs_metric delete_logs_metric(metric_id) Delete a log-based metric Delete a specific log-based metric from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Delete a log-based metric api_instance.delete_logs_metric(metric_id) except ApiException as e: print(\"Exception when calling LogsMetricsApi->delete_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes metric_id str The name of the log-based metric. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_logs_metric LogsMetricResponse get_logs_metric(metric_id) Get a log-based metric Get a specific log-based metric from your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Get a log-based metric api_response = api_instance.get_logs_metric(metric_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->get_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes metric_id str The name of the log-based metric. Return type LogsMetricResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_logs_metrics LogsMetricsResponse list_logs_metrics() Get all log-based metrics Get the list of configured log-based metrics with their definitions. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all log-based metrics api_response = api_instance.list_logs_metrics() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->list_logs_metrics: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type LogsMetricsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Not Authorized - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_logs_metric LogsMetricResponse update_logs_metric(metric_id, body) Update a log-based metric Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. body = LogsMetricUpdateRequest( data=LogsMetricUpdateData( attributes=LogsMetricUpdateAttributes( filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricUpdateRequest | New definition of the log-based metric. # example passing only required values which don't have defaults set try: # Update a log-based metric api_response = api_instance.update_logs_metric(metric_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->update_logs_metric: %s\\n\" % e) Parameters Name Type Description Notes metric_id str The name of the log-based metric. body LogsMetricUpdateRequest New definition of the log-based metric. Return type LogsMetricResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.LogsMetricsApi"},{"location":"v2/LogsMetricsApi/#datadog_api_clientv2logsmetricsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric","title":"datadog_api_client.v2.LogsMetricsApi"},{"location":"v2/LogsMetricsApi/#create_logs_metric","text":"LogsMetricResponse create_logs_metric(body) Create a log-based metric Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful.","title":"create_logs_metric"},{"location":"v2/LogsMetricsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) body = LogsMetricCreateRequest( data=LogsMetricCreateData( attributes=LogsMetricCreateAttributes( compute=LogsMetricCompute( aggregation_type=LogsMetricComputeAggregationType(\"distribution\"), path=\"@duration\", ), filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), id=\"logs.page.load.count\", type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricCreateRequest | The definition of the new log-based metric. # example passing only required values which don't have defaults set try: # Create a log-based metric api_response = api_instance.create_logs_metric(body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->create_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters","text":"Name Type Description Notes body LogsMetricCreateRequest The definition of the new log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type","text":"LogsMetricResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 409 Conflict - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#delete_logs_metric","text":"delete_logs_metric(metric_id) Delete a log-based metric Delete a specific log-based metric from your organization.","title":"delete_logs_metric"},{"location":"v2/LogsMetricsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Delete a log-based metric api_instance.delete_logs_metric(metric_id) except ApiException as e: print(\"Exception when calling LogsMetricsApi->delete_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_1","text":"Name Type Description Notes metric_id str The name of the log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#get_logs_metric","text":"LogsMetricResponse get_logs_metric(metric_id) Get a log-based metric Get a specific log-based metric from your organization.","title":"get_logs_metric"},{"location":"v2/LogsMetricsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. # example passing only required values which don't have defaults set try: # Get a log-based metric api_response = api_instance.get_logs_metric(metric_id) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->get_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_2","text":"Name Type Description Notes metric_id str The name of the log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_2","text":"LogsMetricResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#list_logs_metrics","text":"LogsMetricsResponse list_logs_metrics() Get all log-based metrics Get the list of configured log-based metrics with their definitions.","title":"list_logs_metrics"},{"location":"v2/LogsMetricsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) # example, this endpoint has no required or optional parameters try: # Get all log-based metrics api_response = api_instance.list_logs_metrics() pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->list_logs_metrics: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_3","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_3","text":"LogsMetricsResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 403 Not Authorized - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsApi/#update_logs_metric","text":"LogsMetricResponse update_logs_metric(metric_id, body) Update a log-based metric Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful.","title":"update_logs_metric"},{"location":"v2/LogsMetricsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import logs_metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = logs_metrics_api.LogsMetricsApi(api_client) metric_id = \"metric_id_example\" # str | The name of the log-based metric. body = LogsMetricUpdateRequest( data=LogsMetricUpdateData( attributes=LogsMetricUpdateAttributes( filter=LogsMetricFilter( query=\"service:web* AND @http.status_code:[200 TO 299]\", ), group_by=[ LogsMetricGroupBy( path=\"@http.status_code\", tag_name=\"status_code\", ), ], ), type=LogsMetricType(\"logs_metrics\"), ), ) # LogsMetricUpdateRequest | New definition of the log-based metric. # example passing only required values which don't have defaults set try: # Update a log-based metric api_response = api_instance.update_logs_metric(metric_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling LogsMetricsApi->update_logs_metric: %s\\n\" % e)","title":"Example"},{"location":"v2/LogsMetricsApi/#parameters_4","text":"Name Type Description Notes metric_id str The name of the log-based metric. body LogsMetricUpdateRequest New definition of the log-based metric.","title":"Parameters"},{"location":"v2/LogsMetricsApi/#return-type_4","text":"LogsMetricResponse","title":"Return type"},{"location":"v2/LogsMetricsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/LogsMetricsApi/#http-request-headers_4","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/LogsMetricsApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - 404 Not Found - 429 Too many requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/LogsMetricsResponse/","text":"LogsMetricsResponse All the available log-based metric objects. Properties Name Type Description Notes data [LogsMetricResponseData] A list of log-based metric objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsMetricsResponse"},{"location":"v2/LogsMetricsResponse/#logsmetricsresponse","text":"All the available log-based metric objects.","title":"LogsMetricsResponse"},{"location":"v2/LogsMetricsResponse/#properties","text":"Name Type Description Notes data [LogsMetricResponseData] A list of log-based metric objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsQueryFilter/","text":"LogsQueryFilter The search and filter query settings Properties Name Type Description Notes _from str The minimum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now-15m\" indexes [str] For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. [optional] if omitted the server will use the default value of [\"*\"] query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" to str The maximum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsQueryFilter"},{"location":"v2/LogsQueryFilter/#logsqueryfilter","text":"The search and filter query settings","title":"LogsQueryFilter"},{"location":"v2/LogsQueryFilter/#properties","text":"Name Type Description Notes _from str The minimum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now-15m\" indexes [str] For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. [optional] if omitted the server will use the default value of [\"*\"] query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of \"*\" to str The maximum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of \"now\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsQueryOptions/","text":"LogsQueryOptions Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail. Properties Name Type Description Notes time_offset int The time offset (in seconds) to apply to the query. [optional] timezone str The timezone can be specified both as an offset, for example: \\\"UTC+03:00\\\". [optional] if omitted the server will use the default value of \"UTC\" [Back to Model list] [Back to API list] [Back to README]","title":"LogsQueryOptions"},{"location":"v2/LogsQueryOptions/#logsqueryoptions","text":"Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.","title":"LogsQueryOptions"},{"location":"v2/LogsQueryOptions/#properties","text":"Name Type Description Notes time_offset int The time offset (in seconds) to apply to the query. [optional] timezone str The timezone can be specified both as an offset, for example: \\\"UTC+03:00\\\". [optional] if omitted the server will use the default value of \"UTC\" [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsResponseMetadata/","text":"LogsResponseMetadata The metadata associated with a request Properties Name Type Description Notes elapsed int The time elapsed in milliseconds [optional] page LogsResponseMetadataPage [optional] request_id str The identifier of the request [optional] status LogsAggregateResponseStatus [optional] warnings [LogsWarning] A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsResponseMetadata"},{"location":"v2/LogsResponseMetadata/#logsresponsemetadata","text":"The metadata associated with a request","title":"LogsResponseMetadata"},{"location":"v2/LogsResponseMetadata/#properties","text":"Name Type Description Notes elapsed int The time elapsed in milliseconds [optional] page LogsResponseMetadataPage [optional] request_id str The identifier of the request [optional] status LogsAggregateResponseStatus [optional] warnings [LogsWarning] A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsResponseMetadataPage/","text":"LogsResponseMetadataPage Paging attributes. Properties Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"LogsResponseMetadataPage"},{"location":"v2/LogsResponseMetadataPage/#logsresponsemetadatapage","text":"Paging attributes.","title":"LogsResponseMetadataPage"},{"location":"v2/LogsResponseMetadataPage/#properties","text":"Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsSort/","text":"LogsSort Sort parameters when querying logs. Properties Name Type Description Notes value str Sort parameters when querying logs. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsSort"},{"location":"v2/LogsSort/#logssort","text":"Sort parameters when querying logs.","title":"LogsSort"},{"location":"v2/LogsSort/#properties","text":"Name Type Description Notes value str Sort parameters when querying logs. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsSortOrder/","text":"LogsSortOrder The order to use, ascending or descending Properties Name Type Description Notes value str The order to use, ascending or descending must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"LogsSortOrder"},{"location":"v2/LogsSortOrder/#logssortorder","text":"The order to use, ascending or descending","title":"LogsSortOrder"},{"location":"v2/LogsSortOrder/#properties","text":"Name Type Description Notes value str The order to use, ascending or descending must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/LogsWarning/","text":"LogsWarning A warning message indicating something that went wrong with the query Properties Name Type Description Notes code str A unique code for this type of warning [optional] detail str A detailed explanation of this specific warning [optional] title str A short human-readable summary of the warning [optional] [Back to Model list] [Back to API list] [Back to README]","title":"LogsWarning"},{"location":"v2/LogsWarning/#logswarning","text":"A warning message indicating something that went wrong with the query","title":"LogsWarning"},{"location":"v2/LogsWarning/#properties","text":"Name Type Description Notes code str A unique code for this type of warning [optional] detail str A detailed explanation of this specific warning [optional] title str A short human-readable summary of the warning [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Metric/","text":"Metric Object for a single metric tag configuration. Properties Name Type Description Notes id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Metric"},{"location":"v2/Metric/#metric","text":"Object for a single metric tag configuration.","title":"Metric"},{"location":"v2/Metric/#properties","text":"Name Type Description Notes id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricAllTags/","text":"MetricAllTags Object for a single metric's indexed tags. Properties Name Type Description Notes attributes MetricAllTagsAttributes [optional] id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricAllTags"},{"location":"v2/MetricAllTags/#metricalltags","text":"Object for a single metric's indexed tags.","title":"MetricAllTags"},{"location":"v2/MetricAllTags/#properties","text":"Name Type Description Notes attributes MetricAllTagsAttributes [optional] id str The metric name for this resource. [optional] type MetricType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricAllTagsAttributes/","text":"MetricAllTagsAttributes Object containing the definition of a metric's tags. Properties Name Type Description Notes tags [str] List of indexed tag value pairs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricAllTagsAttributes"},{"location":"v2/MetricAllTagsAttributes/#metricalltagsattributes","text":"Object containing the definition of a metric's tags.","title":"MetricAllTagsAttributes"},{"location":"v2/MetricAllTagsAttributes/#properties","text":"Name Type Description Notes tags [str] List of indexed tag value pairs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricAllTagsResponse/","text":"MetricAllTagsResponse Response object that includes a single metric's indexed tags. Properties Name Type Description Notes data MetricAllTags [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricAllTagsResponse"},{"location":"v2/MetricAllTagsResponse/#metricalltagsresponse","text":"Response object that includes a single metric's indexed tags.","title":"MetricAllTagsResponse"},{"location":"v2/MetricAllTagsResponse/#properties","text":"Name Type Description Notes data MetricAllTags [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricDistinctVolume/","text":"MetricDistinctVolume Object for a single metric's distinct volume. Properties Name Type Description Notes attributes MetricDistinctVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricDistinctVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricDistinctVolume"},{"location":"v2/MetricDistinctVolume/#metricdistinctvolume","text":"Object for a single metric's distinct volume.","title":"MetricDistinctVolume"},{"location":"v2/MetricDistinctVolume/#properties","text":"Name Type Description Notes attributes MetricDistinctVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricDistinctVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricDistinctVolumeAttributes/","text":"MetricDistinctVolumeAttributes Object containing the definition of a metric's distinct volume. Properties Name Type Description Notes distinct_volume int Distinct volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricDistinctVolumeAttributes"},{"location":"v2/MetricDistinctVolumeAttributes/#metricdistinctvolumeattributes","text":"Object containing the definition of a metric's distinct volume.","title":"MetricDistinctVolumeAttributes"},{"location":"v2/MetricDistinctVolumeAttributes/#properties","text":"Name Type Description Notes distinct_volume int Distinct volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricDistinctVolumeType/","text":"MetricDistinctVolumeType The metric distinct volume type. Properties Name Type Description Notes value str The metric distinct volume type. defaults to \"distinct_metric_volumes\", must be one of [\"distinct_metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricDistinctVolumeType"},{"location":"v2/MetricDistinctVolumeType/#metricdistinctvolumetype","text":"The metric distinct volume type.","title":"MetricDistinctVolumeType"},{"location":"v2/MetricDistinctVolumeType/#properties","text":"Name Type Description Notes value str The metric distinct volume type. defaults to \"distinct_metric_volumes\", must be one of [\"distinct_metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricIngestedIndexedVolume/","text":"MetricIngestedIndexedVolume Object for a single metric's ingested and indexed volume. Properties Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricIngestedIndexedVolume"},{"location":"v2/MetricIngestedIndexedVolume/#metricingestedindexedvolume","text":"Object for a single metric's ingested and indexed volume.","title":"MetricIngestedIndexedVolume"},{"location":"v2/MetricIngestedIndexedVolume/#properties","text":"Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricIngestedIndexedVolumeAttributes/","text":"MetricIngestedIndexedVolumeAttributes Object containing the definition of a metric's ingested and indexed volume. Properties Name Type Description Notes indexed_volume int Indexed volume for the given metric. [optional] ingested_volume int Ingested volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricIngestedIndexedVolumeAttributes"},{"location":"v2/MetricIngestedIndexedVolumeAttributes/#metricingestedindexedvolumeattributes","text":"Object containing the definition of a metric's ingested and indexed volume.","title":"MetricIngestedIndexedVolumeAttributes"},{"location":"v2/MetricIngestedIndexedVolumeAttributes/#properties","text":"Name Type Description Notes indexed_volume int Indexed volume for the given metric. [optional] ingested_volume int Ingested volume for the given metric. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricIngestedIndexedVolumeType/","text":"MetricIngestedIndexedVolumeType The metric ingested and indexed volume type. Properties Name Type Description Notes value str The metric ingested and indexed volume type. defaults to \"metric_volumes\", must be one of [\"metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricIngestedIndexedVolumeType"},{"location":"v2/MetricIngestedIndexedVolumeType/#metricingestedindexedvolumetype","text":"The metric ingested and indexed volume type.","title":"MetricIngestedIndexedVolumeType"},{"location":"v2/MetricIngestedIndexedVolumeType/#properties","text":"Name Type Description Notes value str The metric ingested and indexed volume type. defaults to \"metric_volumes\", must be one of [\"metric_volumes\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfiguration/","text":"MetricTagConfiguration Object for a single metric tag configuration. Properties Name Type Description Notes attributes MetricTagConfigurationAttributes [optional] id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfiguration"},{"location":"v2/MetricTagConfiguration/#metrictagconfiguration","text":"Object for a single metric tag configuration.","title":"MetricTagConfiguration"},{"location":"v2/MetricTagConfiguration/#properties","text":"Name Type Description Notes attributes MetricTagConfigurationAttributes [optional] id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationAttributes/","text":"MetricTagConfigurationAttributes Object containing the definition of a metric tag configuration attributes. Properties Name Type Description Notes created_at datetime Timestamp when the tag configuration was created. [optional] include_percentiles bool Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. [optional] metric_type MetricTagConfigurationMetricTypes [optional] modified_at datetime Timestamp when the tag configuration was last modified. [optional] tags [str] List of tag keys on which to group. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationAttributes"},{"location":"v2/MetricTagConfigurationAttributes/#metrictagconfigurationattributes","text":"Object containing the definition of a metric tag configuration attributes.","title":"MetricTagConfigurationAttributes"},{"location":"v2/MetricTagConfigurationAttributes/#properties","text":"Name Type Description Notes created_at datetime Timestamp when the tag configuration was created. [optional] include_percentiles bool Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. [optional] metric_type MetricTagConfigurationMetricTypes [optional] modified_at datetime Timestamp when the tag configuration was last modified. [optional] tags [str] List of tag keys on which to group. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationCreateAttributes/","text":"MetricTagConfigurationCreateAttributes Object containing the definition of a metric tag configuration to be created. Properties Name Type Description Notes metric_type MetricTagConfigurationMetricTypes tags [str] A list of tag keys that will be queryable for your metric. defaults to [] include_percentiles bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationCreateAttributes"},{"location":"v2/MetricTagConfigurationCreateAttributes/#metrictagconfigurationcreateattributes","text":"Object containing the definition of a metric tag configuration to be created.","title":"MetricTagConfigurationCreateAttributes"},{"location":"v2/MetricTagConfigurationCreateAttributes/#properties","text":"Name Type Description Notes metric_type MetricTagConfigurationMetricTypes tags [str] A list of tag keys that will be queryable for your metric. defaults to [] include_percentiles bool 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] if omitted the server will use the default value of False [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationCreateData/","text":"MetricTagConfigurationCreateData Object for a single metric to be configure tags on. Properties Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationCreateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationCreateData"},{"location":"v2/MetricTagConfigurationCreateData/#metrictagconfigurationcreatedata","text":"Object for a single metric to be configure tags on.","title":"MetricTagConfigurationCreateData"},{"location":"v2/MetricTagConfigurationCreateData/#properties","text":"Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationCreateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationCreateRequest/","text":"MetricTagConfigurationCreateRequest Request object that includes the metric that you would like to configure tags for. Properties Name Type Description Notes data MetricTagConfigurationCreateData [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationCreateRequest"},{"location":"v2/MetricTagConfigurationCreateRequest/#metrictagconfigurationcreaterequest","text":"Request object that includes the metric that you would like to configure tags for.","title":"MetricTagConfigurationCreateRequest"},{"location":"v2/MetricTagConfigurationCreateRequest/#properties","text":"Name Type Description Notes data MetricTagConfigurationCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationMetricTypes/","text":"MetricTagConfigurationMetricTypes The metric's type. Properties Name Type Description Notes value str The metric's type. defaults to \"gauge\", must be one of [\"gauge\", \"count\", \"rate\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationMetricTypes"},{"location":"v2/MetricTagConfigurationMetricTypes/#metrictagconfigurationmetrictypes","text":"The metric's type.","title":"MetricTagConfigurationMetricTypes"},{"location":"v2/MetricTagConfigurationMetricTypes/#properties","text":"Name Type Description Notes value str The metric's type. defaults to \"gauge\", must be one of [\"gauge\", \"count\", \"rate\", \"distribution\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationResponse/","text":"MetricTagConfigurationResponse Response object which includes a single metric's tag configuration. Properties Name Type Description Notes data MetricTagConfiguration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationResponse"},{"location":"v2/MetricTagConfigurationResponse/#metrictagconfigurationresponse","text":"Response object which includes a single metric's tag configuration.","title":"MetricTagConfigurationResponse"},{"location":"v2/MetricTagConfigurationResponse/#properties","text":"Name Type Description Notes data MetricTagConfiguration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationType/","text":"MetricTagConfigurationType The metric tag configuration resource type. Properties Name Type Description Notes value str The metric tag configuration resource type. defaults to \"manage_tags\", must be one of [\"manage_tags\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationType"},{"location":"v2/MetricTagConfigurationType/#metrictagconfigurationtype","text":"The metric tag configuration resource type.","title":"MetricTagConfigurationType"},{"location":"v2/MetricTagConfigurationType/#properties","text":"Name Type Description Notes value str The metric tag configuration resource type. defaults to \"manage_tags\", must be one of [\"manage_tags\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationUpdateAttributes/","text":"MetricTagConfigurationUpdateAttributes Object containing the definition of a metric tag configuration to be updated. Properties Name Type Description Notes include_percentiles bool 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] if omitted the server will use the default value of False tags [str] A list of tag keys that will be queryable for your metric. [optional] if omitted the server will use the default value of [] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationUpdateAttributes"},{"location":"v2/MetricTagConfigurationUpdateAttributes/#metrictagconfigurationupdateattributes","text":"Object containing the definition of a metric tag configuration to be updated.","title":"MetricTagConfigurationUpdateAttributes"},{"location":"v2/MetricTagConfigurationUpdateAttributes/#properties","text":"Name Type Description Notes include_percentiles bool 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] if omitted the server will use the default value of False tags [str] A list of tag keys that will be queryable for your metric. [optional] if omitted the server will use the default value of [] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationUpdateData/","text":"MetricTagConfigurationUpdateData Object for a single tag configuration to be edited. Properties Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationUpdateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationUpdateData"},{"location":"v2/MetricTagConfigurationUpdateData/#metrictagconfigurationupdatedata","text":"Object for a single tag configuration to be edited.","title":"MetricTagConfigurationUpdateData"},{"location":"v2/MetricTagConfigurationUpdateData/#properties","text":"Name Type Description Notes id str The metric name for this resource. type MetricTagConfigurationType attributes MetricTagConfigurationUpdateAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricTagConfigurationUpdateRequest/","text":"MetricTagConfigurationUpdateRequest Request object that includes the metric that you would like to edit the tag configuration on. Properties Name Type Description Notes data MetricTagConfigurationUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"MetricTagConfigurationUpdateRequest"},{"location":"v2/MetricTagConfigurationUpdateRequest/#metrictagconfigurationupdaterequest","text":"Request object that includes the metric that you would like to edit the tag configuration on.","title":"MetricTagConfigurationUpdateRequest"},{"location":"v2/MetricTagConfigurationUpdateRequest/#properties","text":"Name Type Description Notes data MetricTagConfigurationUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricType/","text":"MetricType The metric resource type. Properties Name Type Description Notes value str The metric resource type. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"MetricType"},{"location":"v2/MetricType/#metrictype","text":"The metric resource type.","title":"MetricType"},{"location":"v2/MetricType/#properties","text":"Name Type Description Notes value str The metric resource type. defaults to \"metrics\", must be one of [\"metrics\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricVolumes/","text":"MetricVolumes Possible response objects for a metric's volume. Properties Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricVolumes"},{"location":"v2/MetricVolumes/#metricvolumes","text":"Possible response objects for a metric's volume.","title":"MetricVolumes"},{"location":"v2/MetricVolumes/#properties","text":"Name Type Description Notes attributes MetricIngestedIndexedVolumeAttributes [optional] id str The metric name for this resource. [optional] type MetricIngestedIndexedVolumeType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricVolumesResponse/","text":"MetricVolumesResponse Response object which includes a single metric's volume. Properties Name Type Description Notes data MetricVolumes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricVolumesResponse"},{"location":"v2/MetricVolumesResponse/#metricvolumesresponse","text":"Response object which includes a single metric's volume.","title":"MetricVolumesResponse"},{"location":"v2/MetricVolumesResponse/#properties","text":"Name Type Description Notes data MetricVolumes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricsAndMetricTagConfigurations/","text":"MetricsAndMetricTagConfigurations Object for a metrics and metric tag configurations. Properties Name Type Description Notes id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] attributes MetricTagConfigurationAttributes [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricsAndMetricTagConfigurations"},{"location":"v2/MetricsAndMetricTagConfigurations/#metricsandmetrictagconfigurations","text":"Object for a metrics and metric tag configurations.","title":"MetricsAndMetricTagConfigurations"},{"location":"v2/MetricsAndMetricTagConfigurations/#properties","text":"Name Type Description Notes id str The metric name for this resource. [optional] type MetricTagConfigurationType [optional] attributes MetricTagConfigurationAttributes [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricsAndMetricTagConfigurationsResponse/","text":"MetricsAndMetricTagConfigurationsResponse Response object that includes metrics and metric tag configurations. Properties Name Type Description Notes data [MetricsAndMetricTagConfigurations] Array of metrics and metric tag configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"MetricsAndMetricTagConfigurationsResponse"},{"location":"v2/MetricsAndMetricTagConfigurationsResponse/#metricsandmetrictagconfigurationsresponse","text":"Response object that includes metrics and metric tag configurations.","title":"MetricsAndMetricTagConfigurationsResponse"},{"location":"v2/MetricsAndMetricTagConfigurationsResponse/#properties","text":"Name Type Description Notes data [MetricsAndMetricTagConfigurations] Array of metrics and metric tag configurations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/MetricsApi/","text":"datadog_api_client.v2.MetricsApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name list_tag_configurations GET /api/v2/metrics List tag configurations list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration create_tag_configuration MetricTagConfigurationResponse create_tag_configuration(metric_name, body) Create a tag configuration Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric. Can only be used with application keys of users with the Manage Tags for Metrics permission. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationCreateRequest( data=MetricTagConfigurationCreateData( attributes=MetricTagConfigurationCreateAttributes( include_percentiles=True, metric_type=MetricTagConfigurationMetricTypes(\"count\"), tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationCreateRequest | # example passing only required values which don't have defaults set try: # Create a tag configuration api_response = api_instance.create_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->create_tag_configuration: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationCreateRequest Return type MetricTagConfigurationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - 409 Conflict - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_tag_configuration delete_tag_configuration(metric_name) Delete a tag configuration Deletes a metric's tag configuration. Can only be used with application keys from users with the Manage Tags for Metrics permission. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # Delete a tag configuration api_instance.delete_tag_configuration(metric_name) except ApiException as e: print(\"Exception when calling MetricsApi->delete_tag_configuration: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tag_configuration_by_name MetricTagConfigurationResponse list_tag_configuration_by_name(metric_name) List tag configuration by name Returns the tag configuration for the given metric name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configuration_by_name\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tag configuration by name api_response = api_instance.list_tag_configuration_by_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configuration_by_name: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type MetricTagConfigurationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tag_configurations MetricsAndMetricTagConfigurationsResponse list_tag_configurations() List tag configurations Returns all configured count/gauge/rate/distribution metric names (with additional filters if specified). Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configurations\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) filter_configured = True # bool | Filter metrics that have configured tags. (optional) filter_tags_configured = \"app\" # str | Filter tag configurations by configured tags. (optional) filter_metric_type = MetricTagConfigurationMetricTypes(\"count\") # MetricTagConfigurationMetricTypes | Filter tag configurations by metric type. (optional) filter_include_percentiles = True # bool | Filter distributions with additional percentile aggregations enabled or disabled. (optional) filter_tags = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) window_seconds = 3600 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # List tag configurations api_response = api_instance.list_tag_configurations(filter_configured=filter_configured, filter_tags_configured=filter_tags_configured, filter_metric_type=filter_metric_type, filter_include_percentiles=filter_include_percentiles, filter_tags=filter_tags, window_seconds=window_seconds) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configurations: %s\\n\" % e) Parameters Name Type Description Notes filter_configured bool Filter metrics that have configured tags. [optional] filter_tags_configured str Filter tag configurations by configured tags. [optional] filter_metric_type MetricTagConfigurationMetricTypes Filter tag configurations by metric type. [optional] filter_include_percentiles bool Filter distributions with additional percentile aggregations enabled or disabled. [optional] filter_tags str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional] window_seconds int 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 MetricsAndMetricTagConfigurationsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_tags_by_metric_name MetricAllTagsResponse list_tags_by_metric_name(metric_name) List tags by metric name View indexed tag key-value pairs for a given metric name. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tags by metric name api_response = api_instance.list_tags_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tags_by_metric_name: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type MetricAllTagsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_volumes_by_metric_name MetricVolumesResponse list_volumes_by_metric_name(metric_name) List distinct metric volumes by metric name View distinct metrics volumes for the given metric name. Custom distribution metrics will return both ingested and indexed custom metric volumes. For Metrics without Limits\u2122 beta customers, all metrics will return both ingested/indexed volumes. Custom metrics generated in-app from other products will return null for ingested volumes. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List distinct metric volumes by metric name api_response = api_instance.list_volumes_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_volumes_by_metric_name: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. Return type MetricVolumesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_tag_configuration MetricTagConfigurationResponse update_tag_configuration(metric_name, body) Update a tag configuration Update the tag configuration of a metric or percentile aggregations of a distribution metric. Can only be used with application keys from users with the Manage Tags for Metrics permission. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationUpdateRequest( data=MetricTagConfigurationUpdateData( attributes=MetricTagConfigurationUpdateAttributes( include_percentiles=True, tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationUpdateRequest | # example passing only required values which don't have defaults set try: # Update a tag configuration api_response = api_instance.update_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_tag_configuration: %s\\n\" % e) Parameters Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationUpdateRequest Return type MetricTagConfigurationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.MetricsApi"},{"location":"v2/MetricsApi/#datadog_api_clientv2metricsapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name list_tag_configurations GET /api/v2/metrics List tag configurations list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration","title":"datadog_api_client.v2.MetricsApi"},{"location":"v2/MetricsApi/#create_tag_configuration","text":"MetricTagConfigurationResponse create_tag_configuration(metric_name, body) Create a tag configuration Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric. Can only be used with application keys of users with the Manage Tags for Metrics permission.","title":"create_tag_configuration"},{"location":"v2/MetricsApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"create_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationCreateRequest( data=MetricTagConfigurationCreateData( attributes=MetricTagConfigurationCreateAttributes( include_percentiles=True, metric_type=MetricTagConfigurationMetricTypes(\"count\"), tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationCreateRequest | # example passing only required values which don't have defaults set try: # Create a tag configuration api_response = api_instance.create_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->create_tag_configuration: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters","text":"Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationCreateRequest","title":"Parameters"},{"location":"v2/MetricsApi/#return-type","text":"MetricTagConfigurationResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details","text":"Status code Description Response headers 201 Created - 400 Bad Request - 403 Forbidden - 409 Conflict - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#delete_tag_configuration","text":"delete_tag_configuration(metric_name) Delete a tag configuration Deletes a metric's tag configuration. Can only be used with application keys from users with the Manage Tags for Metrics permission.","title":"delete_tag_configuration"},{"location":"v2/MetricsApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"delete_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # Delete a tag configuration api_instance.delete_tag_configuration(metric_name) except ApiException as e: print(\"Exception when calling MetricsApi->delete_tag_configuration: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_1","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/MetricsApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_1","text":"Status code Description Response headers 204 No Content - 403 Forbidden - 404 Not found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_tag_configuration_by_name","text":"MetricTagConfigurationResponse list_tag_configuration_by_name(metric_name) List tag configuration by name Returns the tag configuration for the given metric name.","title":"list_tag_configuration_by_name"},{"location":"v2/MetricsApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configuration_by_name\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tag configuration by name api_response = api_instance.list_tag_configuration_by_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configuration_by_name: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_2","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_2","text":"MetricTagConfigurationResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_2","text":"Status code Description Response headers 200 Success - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_tag_configurations","text":"MetricsAndMetricTagConfigurationsResponse list_tag_configurations() List tag configurations Returns all configured count/gauge/rate/distribution metric names (with additional filters if specified).","title":"list_tag_configurations"},{"location":"v2/MetricsApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_tag_configurations\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) filter_configured = True # bool | Filter metrics that have configured tags. (optional) filter_tags_configured = \"app\" # str | Filter tag configurations by configured tags. (optional) filter_metric_type = MetricTagConfigurationMetricTypes(\"count\") # MetricTagConfigurationMetricTypes | Filter tag configurations by metric type. (optional) filter_include_percentiles = True # bool | Filter distributions with additional percentile aggregations enabled or disabled. (optional) filter_tags = \"env IN (staging,test) AND service:web\" # str | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. (optional) window_seconds = 3600 # int | 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) # example passing only required values which don't have defaults set # and optional values try: # List tag configurations api_response = api_instance.list_tag_configurations(filter_configured=filter_configured, filter_tags_configured=filter_tags_configured, filter_metric_type=filter_metric_type, filter_include_percentiles=filter_include_percentiles, filter_tags=filter_tags, window_seconds=window_seconds) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tag_configurations: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_3","text":"Name Type Description Notes filter_configured bool Filter metrics that have configured tags. [optional] filter_tags_configured str Filter tag configurations by configured tags. [optional] filter_metric_type MetricTagConfigurationMetricTypes Filter tag configurations by metric type. [optional] filter_include_percentiles bool Filter distributions with additional percentile aggregations enabled or disabled. [optional] filter_tags str Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. [optional] window_seconds int 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]","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_3","text":"MetricsAndMetricTagConfigurationsResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_3","text":"Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_tags_by_metric_name","text":"MetricAllTagsResponse list_tags_by_metric_name(metric_name) List tags by metric name View indexed tag key-value pairs for a given metric name.","title":"list_tags_by_metric_name"},{"location":"v2/MetricsApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List tags by metric name api_response = api_instance.list_tags_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_tags_by_metric_name: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_4","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_4","text":"MetricAllTagsResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_4","text":"Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#list_volumes_by_metric_name","text":"MetricVolumesResponse list_volumes_by_metric_name(metric_name) List distinct metric volumes by metric name View distinct metrics volumes for the given metric name. Custom distribution metrics will return both ingested and indexed custom metric volumes. For Metrics without Limits\u2122 beta customers, all metrics will return both ingested/indexed volumes. Custom metrics generated in-app from other products will return null for ingested volumes.","title":"list_volumes_by_metric_name"},{"location":"v2/MetricsApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. # example passing only required values which don't have defaults set try: # List distinct metric volumes by metric name api_response = api_instance.list_volumes_by_metric_name(metric_name) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->list_volumes_by_metric_name: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_5","text":"Name Type Description Notes metric_name str The name of the metric.","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_5","text":"MetricVolumesResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_5","text":"Status code Description Response headers 200 Success - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/MetricsApi/#update_tag_configuration","text":"MetricTagConfigurationResponse update_tag_configuration(metric_name, body) Update a tag configuration Update the tag configuration of a metric or percentile aggregations of a distribution metric. Can only be used with application keys from users with the Manage Tags for Metrics permission.","title":"update_tag_configuration"},{"location":"v2/MetricsApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import metrics_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"update_tag_configuration\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = metrics_api.MetricsApi(api_client) metric_name = \"dist.http.endpoint.request\" # str | The name of the metric. body = MetricTagConfigurationUpdateRequest( data=MetricTagConfigurationUpdateData( attributes=MetricTagConfigurationUpdateAttributes( include_percentiles=True, tags=[\"app\",\"datacenter\"], ), id=\"test.metric.latency\", type=MetricTagConfigurationType(\"manage_tags\"), ), ) # MetricTagConfigurationUpdateRequest | # example passing only required values which don't have defaults set try: # Update a tag configuration api_response = api_instance.update_tag_configuration(metric_name, body) pprint(api_response) except ApiException as e: print(\"Exception when calling MetricsApi->update_tag_configuration: %s\\n\" % e)","title":"Example"},{"location":"v2/MetricsApi/#parameters_6","text":"Name Type Description Notes metric_name str The name of the metric. body MetricTagConfigurationUpdateRequest","title":"Parameters"},{"location":"v2/MetricsApi/#return-type_6","text":"MetricTagConfigurationResponse","title":"Return type"},{"location":"v2/MetricsApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/MetricsApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/MetricsApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Forbidden - 422 Unprocessable Entity - 429 Too Many Requests - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/Organization/","text":"Organization Organization object. Properties Name Type Description Notes type OrganizationsType attributes OrganizationAttributes [optional] id str ID of the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Organization"},{"location":"v2/Organization/#organization","text":"Organization object.","title":"Organization"},{"location":"v2/Organization/#properties","text":"Name Type Description Notes type OrganizationsType attributes OrganizationAttributes [optional] id str ID of the organization. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/OrganizationAttributes/","text":"OrganizationAttributes Attributes of the organization. Properties Name Type Description Notes created_at datetime Creation time of the organization. [optional] description str Description of the organization. [optional] disabled bool Whether or not the organization is disabled. [optional] modified_at datetime Time of last organization modification. [optional] name str Name of the organization. [optional] public_id str Public ID of the organization. [optional] sharing str Sharing type of the organization. [optional] url str URL of the site that this organization exists at. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationAttributes"},{"location":"v2/OrganizationAttributes/#organizationattributes","text":"Attributes of the organization.","title":"OrganizationAttributes"},{"location":"v2/OrganizationAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the organization. [optional] description str Description of the organization. [optional] disabled bool Whether or not the organization is disabled. [optional] modified_at datetime Time of last organization modification. [optional] name str Name of the organization. [optional] public_id str Public ID of the organization. [optional] sharing str Sharing type of the organization. [optional] url str URL of the site that this organization exists at. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/OrganizationsType/","text":"OrganizationsType Organizations resource type. Properties Name Type Description Notes value str Organizations resource type. defaults to \"orgs\", must be one of [\"orgs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"OrganizationsType"},{"location":"v2/OrganizationsType/#organizationstype","text":"Organizations resource type.","title":"OrganizationsType"},{"location":"v2/OrganizationsType/#properties","text":"Name Type Description Notes value str Organizations resource type. defaults to \"orgs\", must be one of [\"orgs\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Pagination/","text":"Pagination Pagination object. Properties Name Type Description Notes total_count int Total count. [optional] total_filtered_count int Total count of elements matched by the filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Pagination"},{"location":"v2/Pagination/#pagination","text":"Pagination object.","title":"Pagination"},{"location":"v2/Pagination/#properties","text":"Name Type Description Notes total_count int Total count. [optional] total_filtered_count int Total count of elements matched by the filter. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialAPIKey/","text":"PartialAPIKey Partial Datadog API key. Properties Name Type Description Notes attributes PartialAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialAPIKey"},{"location":"v2/PartialAPIKey/#partialapikey","text":"Partial Datadog API key.","title":"PartialAPIKey"},{"location":"v2/PartialAPIKey/#properties","text":"Name Type Description Notes attributes PartialAPIKeyAttributes [optional] id str ID of the API key. [optional] relationships APIKeyRelationships [optional] type APIKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialAPIKeyAttributes/","text":"PartialAPIKeyAttributes Attributes of a partial API key. Properties Name Type Description Notes created_at str Creation date of the API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialAPIKeyAttributes"},{"location":"v2/PartialAPIKeyAttributes/#partialapikeyattributes","text":"Attributes of a partial API key.","title":"PartialAPIKeyAttributes"},{"location":"v2/PartialAPIKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the API key. optional last4 str The last four characters of the API key. optional modified_at str Date the API key was last modified. optional name str Name of the API key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialApplicationKey/","text":"PartialApplicationKey Partial Datadog application key. Properties Name Type Description Notes attributes PartialApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialApplicationKey"},{"location":"v2/PartialApplicationKey/#partialapplicationkey","text":"Partial Datadog application key.","title":"PartialApplicationKey"},{"location":"v2/PartialApplicationKey/#properties","text":"Name Type Description Notes attributes PartialApplicationKeyAttributes [optional] id str ID of the application key. [optional] relationships ApplicationKeyRelationships [optional] type ApplicationKeysType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PartialApplicationKeyAttributes/","text":"PartialApplicationKeyAttributes Attributes of a partial application key. Properties Name Type Description Notes created_at str Creation date of the application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PartialApplicationKeyAttributes"},{"location":"v2/PartialApplicationKeyAttributes/#partialapplicationkeyattributes","text":"Attributes of a partial application key.","title":"PartialApplicationKeyAttributes"},{"location":"v2/PartialApplicationKeyAttributes/#properties","text":"Name Type Description Notes created_at str Creation date of the application key. optional last4 str The last four characters of the application key. optional name str Name of the application key. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Permission/","text":"Permission Permission object. Properties Name Type Description Notes type PermissionsType attributes PermissionAttributes [optional] id str ID of the permission. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Permission"},{"location":"v2/Permission/#permission","text":"Permission object.","title":"Permission"},{"location":"v2/Permission/#properties","text":"Name Type Description Notes type PermissionsType attributes PermissionAttributes [optional] id str ID of the permission. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PermissionAttributes/","text":"PermissionAttributes Attributes of a permission. Properties Name Type Description Notes created datetime Creation time of the permission. [optional] description str Description of the permission. [optional] display_name str Displayed name for the permission. [optional] display_type str Display type. [optional] group_name str Name of the permission group. [optional] name str Name of the permission. [optional] restricted bool Whether or not the permission is restricted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PermissionAttributes"},{"location":"v2/PermissionAttributes/#permissionattributes","text":"Attributes of a permission.","title":"PermissionAttributes"},{"location":"v2/PermissionAttributes/#properties","text":"Name Type Description Notes created datetime Creation time of the permission. [optional] description str Description of the permission. [optional] display_name str Displayed name for the permission. [optional] display_type str Display type. [optional] group_name str Name of the permission group. [optional] name str Name of the permission. [optional] restricted bool Whether or not the permission is restricted. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PermissionsResponse/","text":"PermissionsResponse Payload with API-returned permissions. Properties Name Type Description Notes data [Permission] Array of permissions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"PermissionsResponse"},{"location":"v2/PermissionsResponse/#permissionsresponse","text":"Payload with API-returned permissions.","title":"PermissionsResponse"},{"location":"v2/PermissionsResponse/#properties","text":"Name Type Description Notes data [Permission] Array of permissions. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/PermissionsType/","text":"PermissionsType Permissions resource type. Properties Name Type Description Notes value str Permissions resource type. defaults to \"permissions\", must be one of [\"permissions\", ] [Back to Model list] [Back to API list] [Back to README]","title":"PermissionsType"},{"location":"v2/PermissionsType/#permissionstype","text":"Permissions resource type.","title":"PermissionsType"},{"location":"v2/PermissionsType/#properties","text":"Name Type Description Notes value str Permissions resource type. defaults to \"permissions\", must be one of [\"permissions\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummariesMeta/","text":"ProcessSummariesMeta Response metadata object. Properties Name Type Description Notes page ProcessSummariesMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummariesMeta"},{"location":"v2/ProcessSummariesMeta/#processsummariesmeta","text":"Response metadata object.","title":"ProcessSummariesMeta"},{"location":"v2/ProcessSummariesMeta/#properties","text":"Name Type Description Notes page ProcessSummariesMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummariesMetaPage/","text":"ProcessSummariesMetaPage Paging attributes. Properties Name Type Description Notes after str 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 int Number of results returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummariesMetaPage"},{"location":"v2/ProcessSummariesMetaPage/#processsummariesmetapage","text":"Paging attributes.","title":"ProcessSummariesMetaPage"},{"location":"v2/ProcessSummariesMetaPage/#properties","text":"Name Type Description Notes after str 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 int Number of results returned. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummariesResponse/","text":"ProcessSummariesResponse List of process summaries. Properties Name Type Description Notes data [ProcessSummary] Array of process summary objects. [optional] meta ProcessSummariesMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummariesResponse"},{"location":"v2/ProcessSummariesResponse/#processsummariesresponse","text":"List of process summaries.","title":"ProcessSummariesResponse"},{"location":"v2/ProcessSummariesResponse/#properties","text":"Name Type Description Notes data [ProcessSummary] Array of process summary objects. [optional] meta ProcessSummariesMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummary/","text":"ProcessSummary Process summary object. Properties Name Type Description Notes attributes ProcessSummaryAttributes [optional] id str Process ID. [optional] type ProcessSummaryType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummary"},{"location":"v2/ProcessSummary/#processsummary","text":"Process summary object.","title":"ProcessSummary"},{"location":"v2/ProcessSummary/#properties","text":"Name Type Description Notes attributes ProcessSummaryAttributes [optional] id str Process ID. [optional] type ProcessSummaryType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummaryAttributes/","text":"ProcessSummaryAttributes Attributes for a process summary. Properties Name Type Description Notes cmdline str Process command line. [optional] host str Host running the process. [optional] pid int Process ID. [optional] ppid int Parent process ID. [optional] start str Time the process was started. [optional] tags [str] List of tags associated with the process. [optional] timestamp str Time the process was seen. [optional] user str Process owner. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummaryAttributes"},{"location":"v2/ProcessSummaryAttributes/#processsummaryattributes","text":"Attributes for a process summary.","title":"ProcessSummaryAttributes"},{"location":"v2/ProcessSummaryAttributes/#properties","text":"Name Type Description Notes cmdline str Process command line. [optional] host str Host running the process. [optional] pid int Process ID. [optional] ppid int Parent process ID. [optional] start str Time the process was started. [optional] tags [str] List of tags associated with the process. [optional] timestamp str Time the process was seen. [optional] user str Process owner. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessSummaryType/","text":"ProcessSummaryType Type of process summary. Properties Name Type Description Notes value str Type of process summary. defaults to \"process\", must be one of [\"process\", ] [Back to Model list] [Back to API list] [Back to README]","title":"ProcessSummaryType"},{"location":"v2/ProcessSummaryType/#processsummarytype","text":"Type of process summary.","title":"ProcessSummaryType"},{"location":"v2/ProcessSummaryType/#properties","text":"Name Type Description Notes value str Type of process summary. defaults to \"process\", must be one of [\"process\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ProcessesApi/","text":"datadog_api_client.v2.ProcessesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_processes GET /api/v2/processes Get all processes list_processes ProcessSummariesResponse list_processes() Get all processes Get all processes for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import processes_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = processes_api.ProcessesApi(api_client) search = \"search_example\" # str | String to search processes by. (optional) tags = \"account:prod,user:admin\" # str | Comma-separated list of tags to filter processes by. (optional) _from = 1 # int | 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 = 1 # int | 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 = 1000 # int | Maximum number of results returned. (optional) if omitted the server will use the default value of 1000 page_cursor = \"page[cursor]_example\" # str | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all processes api_response = api_instance.list_processes(search=search, tags=tags, _from=_from, to=to, page_limit=page_limit, page_cursor=page_cursor) pprint(api_response) except ApiException as e: print(\"Exception when calling ProcessesApi->list_processes: %s\\n\" % e) Parameters Name Type Description Notes search str String to search processes by. [optional] tags str Comma-separated list of tags to filter processes by. [optional] _from int 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 int 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 int Maximum number of results returned. [optional] if omitted the server will use the default value of 1000 page_cursor str 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 ProcessSummariesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.ProcessesApi"},{"location":"v2/ProcessesApi/#datadog_api_clientv2processesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description list_processes GET /api/v2/processes Get all processes","title":"datadog_api_client.v2.ProcessesApi"},{"location":"v2/ProcessesApi/#list_processes","text":"ProcessSummariesResponse list_processes() Get all processes Get all processes for your organization.","title":"list_processes"},{"location":"v2/ProcessesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import processes_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = processes_api.ProcessesApi(api_client) search = \"search_example\" # str | String to search processes by. (optional) tags = \"account:prod,user:admin\" # str | Comma-separated list of tags to filter processes by. (optional) _from = 1 # int | 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 = 1 # int | 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 = 1000 # int | Maximum number of results returned. (optional) if omitted the server will use the default value of 1000 page_cursor = \"page[cursor]_example\" # str | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all processes api_response = api_instance.list_processes(search=search, tags=tags, _from=_from, to=to, page_limit=page_limit, page_cursor=page_cursor) pprint(api_response) except ApiException as e: print(\"Exception when calling ProcessesApi->list_processes: %s\\n\" % e)","title":"Example"},{"location":"v2/ProcessesApi/#parameters","text":"Name Type Description Notes search str String to search processes by. [optional] tags str Comma-separated list of tags to filter processes by. [optional] _from int 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 int 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 int Maximum number of results returned. [optional] if omitted the server will use the default value of 1000 page_cursor str String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. [optional]","title":"Parameters"},{"location":"v2/ProcessesApi/#return-type","text":"ProcessSummariesResponse","title":"Return type"},{"location":"v2/ProcessesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/ProcessesApi/#http-request-headers","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/ProcessesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication Error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/QuerySortOrder/","text":"QuerySortOrder Direction of sort. Properties Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"QuerySortOrder"},{"location":"v2/QuerySortOrder/#querysortorder","text":"Direction of sort.","title":"QuerySortOrder"},{"location":"v2/QuerySortOrder/#properties","text":"Name Type Description Notes value str Direction of sort. defaults to \"desc\", must be one of [\"asc\", \"desc\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentIntegrationMetadataData/","text":"RelationshipToIncidentIntegrationMetadataData A relationship reference for an integration metadata object. Properties Name Type Description Notes id str A unique identifier that represents the integration metadata. type IncidentIntegrationMetadataType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentIntegrationMetadataData"},{"location":"v2/RelationshipToIncidentIntegrationMetadataData/#relationshiptoincidentintegrationmetadatadata","text":"A relationship reference for an integration metadata object.","title":"RelationshipToIncidentIntegrationMetadataData"},{"location":"v2/RelationshipToIncidentIntegrationMetadataData/#properties","text":"Name Type Description Notes id str A unique identifier that represents the integration metadata. type IncidentIntegrationMetadataType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentIntegrationMetadatas/","text":"RelationshipToIncidentIntegrationMetadatas A relationship reference for multiple integration metadata objects. Properties Name Type Description Notes data [RelationshipToIncidentIntegrationMetadataData] The integration metadata relationship array [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentIntegrationMetadatas"},{"location":"v2/RelationshipToIncidentIntegrationMetadatas/#relationshiptoincidentintegrationmetadatas","text":"A relationship reference for multiple integration metadata objects.","title":"RelationshipToIncidentIntegrationMetadatas"},{"location":"v2/RelationshipToIncidentIntegrationMetadatas/#properties","text":"Name Type Description Notes data [RelationshipToIncidentIntegrationMetadataData] The integration metadata relationship array [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentPostmortem/","text":"RelationshipToIncidentPostmortem A relationship reference for postmortems. Properties Name Type Description Notes data RelationshipToIncidentPostmortemData [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentPostmortem"},{"location":"v2/RelationshipToIncidentPostmortem/#relationshiptoincidentpostmortem","text":"A relationship reference for postmortems.","title":"RelationshipToIncidentPostmortem"},{"location":"v2/RelationshipToIncidentPostmortem/#properties","text":"Name Type Description Notes data RelationshipToIncidentPostmortemData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToIncidentPostmortemData/","text":"RelationshipToIncidentPostmortemData The postmortem relationship data. Properties Name Type Description Notes id str A unique identifier that represents the postmortem. type IncidentPostmortemType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToIncidentPostmortemData"},{"location":"v2/RelationshipToIncidentPostmortemData/#relationshiptoincidentpostmortemdata","text":"The postmortem relationship data.","title":"RelationshipToIncidentPostmortemData"},{"location":"v2/RelationshipToIncidentPostmortemData/#properties","text":"Name Type Description Notes id str A unique identifier that represents the postmortem. type IncidentPostmortemType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToOrganization/","text":"RelationshipToOrganization Relationship to an organization. Properties Name Type Description Notes data RelationshipToOrganizationData [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToOrganization"},{"location":"v2/RelationshipToOrganization/#relationshiptoorganization","text":"Relationship to an organization.","title":"RelationshipToOrganization"},{"location":"v2/RelationshipToOrganization/#properties","text":"Name Type Description Notes data RelationshipToOrganizationData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToOrganizationData/","text":"RelationshipToOrganizationData Relationship to organization object. Properties Name Type Description Notes id str ID of the organization. type OrganizationsType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToOrganizationData"},{"location":"v2/RelationshipToOrganizationData/#relationshiptoorganizationdata","text":"Relationship to organization object.","title":"RelationshipToOrganizationData"},{"location":"v2/RelationshipToOrganizationData/#properties","text":"Name Type Description Notes id str ID of the organization. type OrganizationsType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToOrganizations/","text":"RelationshipToOrganizations Relationship to organizations. Properties Name Type Description Notes data [RelationshipToOrganizationData] Relationships to organization objects. [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToOrganizations"},{"location":"v2/RelationshipToOrganizations/#relationshiptoorganizations","text":"Relationship to organizations.","title":"RelationshipToOrganizations"},{"location":"v2/RelationshipToOrganizations/#properties","text":"Name Type Description Notes data [RelationshipToOrganizationData] Relationships to organization objects. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToPermission/","text":"RelationshipToPermission Relationship to a permissions object. Properties Name Type Description Notes data RelationshipToPermissionData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToPermission"},{"location":"v2/RelationshipToPermission/#relationshiptopermission","text":"Relationship to a permissions object.","title":"RelationshipToPermission"},{"location":"v2/RelationshipToPermission/#properties","text":"Name Type Description Notes data RelationshipToPermissionData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToPermissionData/","text":"RelationshipToPermissionData Relationship to permission object. Properties Name Type Description Notes id str ID of the permission. [optional] type PermissionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToPermissionData"},{"location":"v2/RelationshipToPermissionData/#relationshiptopermissiondata","text":"Relationship to permission object.","title":"RelationshipToPermissionData"},{"location":"v2/RelationshipToPermissionData/#properties","text":"Name Type Description Notes id str ID of the permission. [optional] type PermissionsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToPermissions/","text":"RelationshipToPermissions Relationship to multiple permissions objects. Properties Name Type Description Notes data [RelationshipToPermissionData] Relationships to permission objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToPermissions"},{"location":"v2/RelationshipToPermissions/#relationshiptopermissions","text":"Relationship to multiple permissions objects.","title":"RelationshipToPermissions"},{"location":"v2/RelationshipToPermissions/#properties","text":"Name Type Description Notes data [RelationshipToPermissionData] Relationships to permission objects. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToRole/","text":"RelationshipToRole Relationship to role. Properties Name Type Description Notes data RelationshipToRoleData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToRole"},{"location":"v2/RelationshipToRole/#relationshiptorole","text":"Relationship to role.","title":"RelationshipToRole"},{"location":"v2/RelationshipToRole/#properties","text":"Name Type Description Notes data RelationshipToRoleData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToRoleData/","text":"RelationshipToRoleData Relationship to role object. Properties Name Type Description Notes id str ID of the role. [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToRoleData"},{"location":"v2/RelationshipToRoleData/#relationshiptoroledata","text":"Relationship to role object.","title":"RelationshipToRoleData"},{"location":"v2/RelationshipToRoleData/#properties","text":"Name Type Description Notes id str ID of the role. [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToRoles/","text":"RelationshipToRoles Relationship to roles. Properties Name Type Description Notes data [RelationshipToRoleData] An array containing type and ID of a role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToRoles"},{"location":"v2/RelationshipToRoles/#relationshiptoroles","text":"Relationship to roles.","title":"RelationshipToRoles"},{"location":"v2/RelationshipToRoles/#properties","text":"Name Type Description Notes data [RelationshipToRoleData] An array containing type and ID of a role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToUser/","text":"RelationshipToUser Relationship to user. Properties Name Type Description Notes data RelationshipToUserData [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToUser"},{"location":"v2/RelationshipToUser/#relationshiptouser","text":"Relationship to user.","title":"RelationshipToUser"},{"location":"v2/RelationshipToUser/#properties","text":"Name Type Description Notes data RelationshipToUserData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToUserData/","text":"RelationshipToUserData Relationship to user object. Properties Name Type Description Notes id str A unique identifier that represents the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToUserData"},{"location":"v2/RelationshipToUserData/#relationshiptouserdata","text":"Relationship to user object.","title":"RelationshipToUserData"},{"location":"v2/RelationshipToUserData/#properties","text":"Name Type Description Notes id str A unique identifier that represents the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RelationshipToUsers/","text":"RelationshipToUsers Relationship to users. Properties Name Type Description Notes data [RelationshipToUserData] Relationships to user objects. [Back to Model list] [Back to API list] [Back to README]","title":"RelationshipToUsers"},{"location":"v2/RelationshipToUsers/#relationshiptousers","text":"Relationship to users.","title":"RelationshipToUsers"},{"location":"v2/RelationshipToUsers/#properties","text":"Name Type Description Notes data [RelationshipToUserData] Relationships to user objects. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/ResponseMetaAttributes/","text":"ResponseMetaAttributes Object describing meta attributes of response. Properties Name Type Description Notes page Pagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"ResponseMetaAttributes"},{"location":"v2/ResponseMetaAttributes/#responsemetaattributes","text":"Object describing meta attributes of response.","title":"ResponseMetaAttributes"},{"location":"v2/ResponseMetaAttributes/#properties","text":"Name Type Description Notes page Pagination [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/Role/","text":"Role Role object returned by the API. Properties Name Type Description Notes type RolesType attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Role"},{"location":"v2/Role/#role","text":"Role object returned by the API.","title":"Role"},{"location":"v2/Role/#properties","text":"Name Type Description Notes type RolesType attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleAttributes/","text":"RoleAttributes Attributes of the role. Properties Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] user_count int Number of users with that role. optional [Back to Model list] [Back to API list] [Back to README]","title":"RoleAttributes"},{"location":"v2/RoleAttributes/#roleattributes","text":"Attributes of the role.","title":"RoleAttributes"},{"location":"v2/RoleAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] user_count int Number of users with that role. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateAttributes/","text":"RoleCreateAttributes Attributes of the created role. Properties Name Type Description Notes name str Name of the role. created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateAttributes"},{"location":"v2/RoleCreateAttributes/#rolecreateattributes","text":"Attributes of the created role.","title":"RoleCreateAttributes"},{"location":"v2/RoleCreateAttributes/#properties","text":"Name Type Description Notes name str Name of the role. created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateData/","text":"RoleCreateData Data related to the creation of a role. Properties Name Type Description Notes attributes RoleCreateAttributes relationships RoleRelationships [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateData"},{"location":"v2/RoleCreateData/#rolecreatedata","text":"Data related to the creation of a role.","title":"RoleCreateData"},{"location":"v2/RoleCreateData/#properties","text":"Name Type Description Notes attributes RoleCreateAttributes relationships RoleRelationships [optional] type RolesType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateRequest/","text":"RoleCreateRequest Create a role. Properties Name Type Description Notes data RoleCreateData [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateRequest"},{"location":"v2/RoleCreateRequest/#rolecreaterequest","text":"Create a role.","title":"RoleCreateRequest"},{"location":"v2/RoleCreateRequest/#properties","text":"Name Type Description Notes data RoleCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateResponse/","text":"RoleCreateResponse Response containing information about a created role. Properties Name Type Description Notes data RoleCreateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateResponse"},{"location":"v2/RoleCreateResponse/#rolecreateresponse","text":"Response containing information about a created role.","title":"RoleCreateResponse"},{"location":"v2/RoleCreateResponse/#properties","text":"Name Type Description Notes data RoleCreateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleCreateResponseData/","text":"RoleCreateResponseData Role object returned by the API. Properties Name Type Description Notes type RolesType attributes RoleCreateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleCreateResponseData"},{"location":"v2/RoleCreateResponseData/#rolecreateresponsedata","text":"Role object returned by the API.","title":"RoleCreateResponseData"},{"location":"v2/RoleCreateResponseData/#properties","text":"Name Type Description Notes type RolesType attributes RoleCreateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleRelationships/","text":"RoleRelationships Relationships of the role object. Properties Name Type Description Notes permissions RelationshipToPermissions [optional] users RelationshipToUsers [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleRelationships"},{"location":"v2/RoleRelationships/#rolerelationships","text":"Relationships of the role object.","title":"RoleRelationships"},{"location":"v2/RoleRelationships/#properties","text":"Name Type Description Notes permissions RelationshipToPermissions [optional] users RelationshipToUsers [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleResponse/","text":"RoleResponse Response containing information about a single role. Properties Name Type Description Notes data Role [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleResponse"},{"location":"v2/RoleResponse/#roleresponse","text":"Response containing information about a single role.","title":"RoleResponse"},{"location":"v2/RoleResponse/#properties","text":"Name Type Description Notes data Role [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleResponseRelationships/","text":"RoleResponseRelationships Relationships of the role object returned by the API. Properties Name Type Description Notes permissions RelationshipToPermissions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleResponseRelationships"},{"location":"v2/RoleResponseRelationships/#roleresponserelationships","text":"Relationships of the role object returned by the API.","title":"RoleResponseRelationships"},{"location":"v2/RoleResponseRelationships/#properties","text":"Name Type Description Notes permissions RelationshipToPermissions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateAttributes/","text":"RoleUpdateAttributes Attributes of the role. Properties Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateAttributes"},{"location":"v2/RoleUpdateAttributes/#roleupdateattributes","text":"Attributes of the role.","title":"RoleUpdateAttributes"},{"location":"v2/RoleUpdateAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the role. optional modified_at datetime Time of last role modification. optional name str Name of the role. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateData/","text":"RoleUpdateData Data related to the update of a role. Properties Name Type Description Notes attributes RoleUpdateAttributes id str ID of the role. type RolesType [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateData"},{"location":"v2/RoleUpdateData/#roleupdatedata","text":"Data related to the update of a role.","title":"RoleUpdateData"},{"location":"v2/RoleUpdateData/#properties","text":"Name Type Description Notes attributes RoleUpdateAttributes id str ID of the role. type RolesType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateRequest/","text":"RoleUpdateRequest Update a role. Properties Name Type Description Notes data RoleUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateRequest"},{"location":"v2/RoleUpdateRequest/#roleupdaterequest","text":"Update a role.","title":"RoleUpdateRequest"},{"location":"v2/RoleUpdateRequest/#properties","text":"Name Type Description Notes data RoleUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateResponse/","text":"RoleUpdateResponse Response containing information about an updated role. Properties Name Type Description Notes data RoleUpdateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateResponse"},{"location":"v2/RoleUpdateResponse/#roleupdateresponse","text":"Response containing information about an updated role.","title":"RoleUpdateResponse"},{"location":"v2/RoleUpdateResponse/#properties","text":"Name Type Description Notes data RoleUpdateResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RoleUpdateResponseData/","text":"RoleUpdateResponseData Role object returned by the API. Properties Name Type Description Notes type RolesType attributes RoleUpdateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RoleUpdateResponseData"},{"location":"v2/RoleUpdateResponseData/#roleupdateresponsedata","text":"Role object returned by the API.","title":"RoleUpdateResponseData"},{"location":"v2/RoleUpdateResponseData/#properties","text":"Name Type Description Notes type RolesType attributes RoleUpdateAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RolesApi/","text":"datadog_api_client.v2.RolesApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role create_role POST /api/v2/roles Create role delete_role DELETE /api/v2/roles/{role_id} Delete role get_role GET /api/v2/roles/{role_id} Get a role list_permissions GET /api/v2/permissions List permissions list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role list_roles GET /api/v2/roles List roles remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role update_role PATCH /api/v2/roles/{role_id} Update a role add_permission_to_role PermissionsResponse add_permission_to_role(role_id, body) Grant permission to a role Adds a permission to a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Grant permission to a role api_response = api_instance.add_permission_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_permission_to_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] add_user_to_role UsersResponse add_user_to_role(role_id, body) Add a user to a role Adds a user to a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Add a user to a role api_response = api_instance.add_user_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_user_to_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToUser Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] create_role RoleCreateResponse create_role(body) Create role Create a new role for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) body = RoleCreateRequest( data=RoleCreateData( attributes=RoleCreateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"developers\", ), relationships=RoleRelationships( permissions=RelationshipToPermissions( data=[ RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ], ), users=RelationshipToUsers( data=[ RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ], ), ), type=RolesType(\"roles\"), ), ) # RoleCreateRequest | # example passing only required values which don't have defaults set try: # Create role api_response = api_instance.create_role(body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->create_role: %s\\n\" % e) Parameters Name Type Description Notes body RoleCreateRequest Return type RoleCreateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_role delete_role(role_id) Delete role Disables a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Delete role api_instance.delete_role(role_id) except ApiException as e: print(\"Exception when calling RolesApi->delete_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_role RoleResponse get_role(role_id) Get a role Get a role in the organization specified by the role\u2019s role_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Get a role api_response = api_instance.get_role(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->get_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. Return type RoleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_permissions PermissionsResponse list_permissions() List permissions Returns a list of all permissions, including name, description, and ID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) # example, this endpoint has no required or optional parameters try: # List permissions api_response = api_instance.list_permissions() pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_permissions: %s\\n\" % e) Parameters This endpoint does not need any parameter. Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_role_permissions PermissionsResponse list_role_permissions(role_id) List permissions for a role Returns a list of all permissions for a single role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # List permissions for a role api_response = api_instance.list_role_permissions(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_permissions: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_role_users UsersResponse list_role_users(role_id) Get all users of a role Gets all users of a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set try: # Get all users of a role api_response = api_instance.list_role_users(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get all users of a role api_response = api_instance.list_role_users(role_id, page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" filter str Filter all users by the given string. Defaults to no filtering. [optional] Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_roles RolesResponse list_roles() List roles Returns all roles, including their names and IDs. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = RolesSort(\"name\") # 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) filter = \"filter_example\" # str | Filter all roles by the given string. (optional) # example passing only required values which don't have defaults set # and optional values try: # List roles api_response = api_instance.list_roles(page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_roles: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter all roles by the given string. [optional] Return type RolesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_permission_from_role PermissionsResponse remove_permission_from_role(role_id, body) Revoke permission Removes a permission from a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Revoke permission api_response = api_instance.remove_permission_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_permission_from_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] remove_user_from_role UsersResponse remove_user_from_role(role_id, body) Remove a user from a role Removes a user from a role. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Remove a user from a role api_response = api_instance.remove_user_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_user_from_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RelationshipToUser Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_role RoleUpdateResponse update_role(role_id, body) Update a role Edit a role. Can only be used with application keys belonging to administrators. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RoleUpdateRequest( data=RoleUpdateData( attributes=RoleUpdateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=RolesType(\"roles\"), ), ) # RoleUpdateRequest | # example passing only required values which don't have defaults set try: # Update a role api_response = api_instance.update_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->update_role: %s\\n\" % e) Parameters Name Type Description Notes role_id str The ID of the role. body RoleUpdateRequest Return type RoleUpdateResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.RolesApi"},{"location":"v2/RolesApi/#datadog_api_clientv2rolesapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role create_role POST /api/v2/roles Create role delete_role DELETE /api/v2/roles/{role_id} Delete role get_role GET /api/v2/roles/{role_id} Get a role list_permissions GET /api/v2/permissions List permissions list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role list_roles GET /api/v2/roles List roles remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role update_role PATCH /api/v2/roles/{role_id} Update a role","title":"datadog_api_client.v2.RolesApi"},{"location":"v2/RolesApi/#add_permission_to_role","text":"PermissionsResponse add_permission_to_role(role_id, body) Grant permission to a role Adds a permission to a role.","title":"add_permission_to_role"},{"location":"v2/RolesApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Grant permission to a role api_response = api_instance.add_permission_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_permission_to_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission","title":"Parameters"},{"location":"v2/RolesApi/#return-type","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#add_user_to_role","text":"UsersResponse add_user_to_role(role_id, body) Add a user to a role Adds a user to a role.","title":"add_user_to_role"},{"location":"v2/RolesApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Add a user to a role api_response = api_instance.add_user_to_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->add_user_to_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_1","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToUser","title":"Parameters"},{"location":"v2/RolesApi/#return-type_1","text":"UsersResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_1","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_1","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#create_role","text":"RoleCreateResponse create_role(body) Create role Create a new role for your organization.","title":"create_role"},{"location":"v2/RolesApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) body = RoleCreateRequest( data=RoleCreateData( attributes=RoleCreateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"developers\", ), relationships=RoleRelationships( permissions=RelationshipToPermissions( data=[ RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ], ), users=RelationshipToUsers( data=[ RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ], ), ), type=RolesType(\"roles\"), ), ) # RoleCreateRequest | # example passing only required values which don't have defaults set try: # Create role api_response = api_instance.create_role(body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->create_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_2","text":"Name Type Description Notes body RoleCreateRequest","title":"Parameters"},{"location":"v2/RolesApi/#return-type_2","text":"RoleCreateResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_2","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#delete_role","text":"delete_role(role_id) Delete role Disables a role.","title":"delete_role"},{"location":"v2/RolesApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Delete role api_instance.delete_role(role_id) except ApiException as e: print(\"Exception when calling RolesApi->delete_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_3","text":"Name Type Description Notes role_id str The ID of the role.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_3","text":"void (empty response body)","title":"Return type"},{"location":"v2/RolesApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_3","text":"Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#get_role","text":"RoleResponse get_role(role_id) Get a role Get a role in the organization specified by the role\u2019s role_id .","title":"get_role"},{"location":"v2/RolesApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # Get a role api_response = api_instance.get_role(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->get_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_4","text":"Name Type Description Notes role_id str The ID of the role.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_4","text":"RoleResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_permissions","text":"PermissionsResponse list_permissions() List permissions Returns a list of all permissions, including name, description, and ID.","title":"list_permissions"},{"location":"v2/RolesApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) # example, this endpoint has no required or optional parameters try: # List permissions api_response = api_instance.list_permissions() pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_permissions: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_5","text":"This endpoint does not need any parameter.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_5","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_role_permissions","text":"PermissionsResponse list_role_permissions(role_id) List permissions for a role Returns a list of all permissions for a single role.","title":"list_role_permissions"},{"location":"v2/RolesApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. # example passing only required values which don't have defaults set try: # List permissions for a role api_response = api_instance.list_role_permissions(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_permissions: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_6","text":"Name Type Description Notes role_id str The ID of the role.","title":"Parameters"},{"location":"v2/RolesApi/#return-type_6","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_role_users","text":"UsersResponse list_role_users(role_id) Get all users of a role Gets all users of a role.","title":"list_role_users"},{"location":"v2/RolesApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set try: # Get all users of a role api_response = api_instance.list_role_users(role_id) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e) # example passing only required values which don't have defaults set # and optional values try: # Get all users of a role api_response = api_instance.list_role_users(role_id, page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_role_users: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_7","text":"Name Type Description Notes role_id str The ID of the role. page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" filter str Filter all users by the given string. Defaults to no filtering. [optional]","title":"Parameters"},{"location":"v2/RolesApi/#return-type_7","text":"UsersResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_7","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_7","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#list_roles","text":"RolesResponse list_roles() List roles Returns all roles, including their names and IDs.","title":"list_roles"},{"location":"v2/RolesApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = RolesSort(\"name\") # 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) filter = \"filter_example\" # str | Filter all roles by the given string. (optional) # example passing only required values which don't have defaults set # and optional values try: # List roles api_response = api_instance.list_roles(page_size=page_size, page_number=page_number, sort=sort, filter=filter) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->list_roles: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_8","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 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] filter str Filter all roles by the given string. [optional]","title":"Parameters"},{"location":"v2/RolesApi/#return-type_8","text":"RolesResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_8","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#remove_permission_from_role","text":"PermissionsResponse remove_permission_from_role(role_id, body) Revoke permission Removes a permission from a role.","title":"remove_permission_from_role"},{"location":"v2/RolesApi/#example_9","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToPermission( data=RelationshipToPermissionData( id=\"id_example\", type=PermissionsType(\"permissions\"), ), ) # RelationshipToPermission | # example passing only required values which don't have defaults set try: # Revoke permission api_response = api_instance.remove_permission_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_permission_from_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_9","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToPermission","title":"Parameters"},{"location":"v2/RolesApi/#return-type_9","text":"PermissionsResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_9","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_9","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_9","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#remove_user_from_role","text":"UsersResponse remove_user_from_role(role_id, body) Remove a user from a role Removes a user from a role.","title":"remove_user_from_role"},{"location":"v2/RolesApi/#example_10","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # RelationshipToUser | # example passing only required values which don't have defaults set try: # Remove a user from a role api_response = api_instance.remove_user_from_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->remove_user_from_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_10","text":"Name Type Description Notes role_id str The ID of the role. body RelationshipToUser","title":"Parameters"},{"location":"v2/RolesApi/#return-type_10","text":"UsersResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_10","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_10","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_10","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesApi/#update_role","text":"RoleUpdateResponse update_role(role_id, body) Update a role Edit a role. Can only be used with application keys belonging to administrators.","title":"update_role"},{"location":"v2/RolesApi/#example_11","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import roles_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = roles_api.RolesApi(api_client) role_id = \"role_id_example\" # str | The ID of the role. body = RoleUpdateRequest( data=RoleUpdateData( attributes=RoleUpdateAttributes( created_at=dateutil_parser('1970-01-01T00:00:00.00Z'), modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'), name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=RolesType(\"roles\"), ), ) # RoleUpdateRequest | # example passing only required values which don't have defaults set try: # Update a role api_response = api_instance.update_role(role_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling RolesApi->update_role: %s\\n\" % e)","title":"Example"},{"location":"v2/RolesApi/#parameters_11","text":"Name Type Description Notes role_id str The ID of the role. body RoleUpdateRequest","title":"Parameters"},{"location":"v2/RolesApi/#return-type_11","text":"RoleUpdateResponse","title":"Return type"},{"location":"v2/RolesApi/#authorization_11","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/RolesApi/#http-request-headers_11","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/RolesApi/#http-response-details_11","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/RolesResponse/","text":"RolesResponse Response containing information about multiple roles. Properties Name Type Description Notes data [Role] Array of returned roles. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"RolesResponse"},{"location":"v2/RolesResponse/#rolesresponse","text":"Response containing information about multiple roles.","title":"RolesResponse"},{"location":"v2/RolesResponse/#properties","text":"Name Type Description Notes data [Role] Array of returned roles. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RolesSort/","text":"RolesSort Sorting options for roles. Properties Name Type Description Notes value str Sorting options for roles. defaults to \"name\", must be one of [\"name\", \"-name\", \"modified_at\", \"-modified_at\", \"user_count\", \"-user_count\", ] [Back to Model list] [Back to API list] [Back to README]","title":"RolesSort"},{"location":"v2/RolesSort/#rolessort","text":"Sorting options for roles.","title":"RolesSort"},{"location":"v2/RolesSort/#properties","text":"Name Type Description Notes value str Sorting options for roles. defaults to \"name\", must be one of [\"name\", \"-name\", \"modified_at\", \"-modified_at\", \"user_count\", \"-user_count\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/RolesType/","text":"RolesType Roles type. Properties Name Type Description Notes value str Roles type. defaults to \"roles\", must be one of [\"roles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"RolesType"},{"location":"v2/RolesType/#rolestype","text":"Roles type.","title":"RolesType"},{"location":"v2/RolesType/#properties","text":"Name Type Description Notes value str Roles type. defaults to \"roles\", must be one of [\"roles\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringApi/","text":"datadog_api_client.v2.SecurityMonitoringApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule create_security_monitoring_rule SecurityMonitoringRuleResponse create_security_monitoring_rule(body) Create a detection rule Create a detection rule. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringRuleCreatePayload( cases=[ SecurityMonitoringRuleCaseCreate( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"\", name=\"\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQueryCreate( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"a < 3\", ), ], tags=[\"env:prod\",\"team:security\"], ) # SecurityMonitoringRuleCreatePayload | # example passing only required values which don't have defaults set try: # Create a detection rule api_response = api_instance.create_security_monitoring_rule(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->create_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes body SecurityMonitoringRuleCreatePayload Return type SecurityMonitoringRuleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] delete_security_monitoring_rule delete_security_monitoring_rule(rule_id) Delete an existing rule Delete an existing rule. Default rules cannot be deleted. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Delete an existing rule api_instance.delete_security_monitoring_rule(rule_id) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->delete_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes rule_id str The ID of the rule. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_security_monitoring_rule SecurityMonitoringRuleResponse get_security_monitoring_rule(rule_id) Get a rule's details Get a rule's details. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Get a rule's details api_response = api_instance.get_security_monitoring_rule(rule_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->get_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes rule_id str The ID of the rule. Return type SecurityMonitoringRuleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_security_monitoring_rules SecurityMonitoringListRulesResponse list_security_monitoring_rules() List rules List rules. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # List rules api_response = api_instance.list_security_monitoring_rules(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_rules: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 Return type SecurityMonitoringListRulesResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_security_monitoring_signals SecurityMonitoringSignalsListResponse list_security_monitoring_signals() Get a quick list of security signals The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) filter_query = \"security:attack status:high\" # str | The search query for security signals. (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | The minimum timestamp for requested security signals. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | The maximum timestamp for requested security signals. (optional) sort = SecurityMonitoringSignalsSort(\"timestamp\") # SecurityMonitoringSignalsSort | The order of the security signals in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | A list of results using the cursor provided in the previous query. (optional) page_limit = 25 # int | The maximum number of security signals in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a quick list of security signals api_response = api_instance.list_security_monitoring_signals(filter_query=filter_query, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_signals: %s\\n\" % e) Parameters Name Type Description Notes filter_query str The search query for security signals. [optional] filter_from datetime The minimum timestamp for requested security signals. [optional] filter_to datetime The maximum timestamp for requested security signals. [optional] sort SecurityMonitoringSignalsSort The order of the security signals in results. [optional] page_cursor str A list of results using the cursor provided in the previous query. [optional] page_limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10 Return type SecurityMonitoringSignalsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] search_security_monitoring_signals SecurityMonitoringSignalsListResponse search_security_monitoring_signals() Get a list of security signals Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing security signals. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"search_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringSignalListRequest( filter=SecurityMonitoringSignalListRequestFilter( _from=dateutil_parser('2019-01-02T09:42:36.32Z'), query=\"security:attack status:high\", to=dateutil_parser('2019-01-03T09:42:36.32Z'), ), page=SecurityMonitoringSignalListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=SecurityMonitoringSignalsSort(\"timestamp\"), ) # SecurityMonitoringSignalListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of security signals api_response = api_instance.search_security_monitoring_signals(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->search_security_monitoring_signals: %s\\n\" % e) Parameters Name Type Description Notes body SecurityMonitoringSignalListRequest [optional] Return type SecurityMonitoringSignalsListResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_security_monitoring_rule SecurityMonitoringRuleResponse update_security_monitoring_rule(rule_id, body) Update an existing rule Update an existing rule. When updating cases , queries or options , the whole field must be included. For example, when modifying a query all queries must be included. Default rules can only be updated to be enabled and to change notifications. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. body = SecurityMonitoringRuleUpdatePayload( cases=[ SecurityMonitoringRuleCase( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"message_example\", name=\"name_example\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQuery( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"query_example\", ), ], tags=[ \"tags_example\", ], ) # SecurityMonitoringRuleUpdatePayload | # example passing only required values which don't have defaults set try: # Update an existing rule api_response = api_instance.update_security_monitoring_rule(rule_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->update_security_monitoring_rule: %s\\n\" % e) Parameters Name Type Description Notes rule_id str The ID of the rule. body SecurityMonitoringRuleUpdatePayload Return type SecurityMonitoringRuleResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 401 Concurrent Modification - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.SecurityMonitoringApi"},{"location":"v2/SecurityMonitoringApi/#datadog_api_clientv2securitymonitoringapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule","title":"datadog_api_client.v2.SecurityMonitoringApi"},{"location":"v2/SecurityMonitoringApi/#create_security_monitoring_rule","text":"SecurityMonitoringRuleResponse create_security_monitoring_rule(body) Create a detection rule Create a detection rule.","title":"create_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringRuleCreatePayload( cases=[ SecurityMonitoringRuleCaseCreate( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"\", name=\"\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQueryCreate( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"a < 3\", ), ], tags=[\"env:prod\",\"team:security\"], ) # SecurityMonitoringRuleCreatePayload | # example passing only required values which don't have defaults set try: # Create a detection rule api_response = api_instance.create_security_monitoring_rule(body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->create_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters","text":"Name Type Description Notes body SecurityMonitoringRuleCreatePayload","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type","text":"SecurityMonitoringRuleResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#delete_security_monitoring_rule","text":"delete_security_monitoring_rule(rule_id) Delete an existing rule Delete an existing rule. Default rules cannot be deleted.","title":"delete_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Delete an existing rule api_instance.delete_security_monitoring_rule(rule_id) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->delete_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_1","text":"Name Type Description Notes rule_id str The ID of the rule.","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#get_security_monitoring_rule","text":"SecurityMonitoringRuleResponse get_security_monitoring_rule(rule_id) Get a rule's details Get a rule's details.","title":"get_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. # example passing only required values which don't have defaults set try: # Get a rule's details api_response = api_instance.get_security_monitoring_rule(rule_id) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->get_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_2","text":"Name Type Description Notes rule_id str The ID of the rule.","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_2","text":"SecurityMonitoringRuleResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#list_security_monitoring_rules","text":"SecurityMonitoringListRulesResponse list_security_monitoring_rules() List rules List rules.","title":"list_security_monitoring_rules"},{"location":"v2/SecurityMonitoringApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 # example passing only required values which don't have defaults set # and optional values try: # List rules api_response = api_instance.list_security_monitoring_rules(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_rules: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_3","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_3","text":"SecurityMonitoringListRulesResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_3","text":"Status code Description Response headers 200 OK - 400 Bad Request - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#list_security_monitoring_signals","text":"SecurityMonitoringSignalsListResponse list_security_monitoring_signals() Get a quick list of security signals The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals.","title":"list_security_monitoring_signals"},{"location":"v2/SecurityMonitoringApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"list_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) filter_query = \"security:attack status:high\" # str | The search query for security signals. (optional) filter_from = dateutil_parser('2019-01-02T09:42:36.320Z') # datetime | The minimum timestamp for requested security signals. (optional) filter_to = dateutil_parser('2019-01-03T09:42:36.320Z') # datetime | The maximum timestamp for requested security signals. (optional) sort = SecurityMonitoringSignalsSort(\"timestamp\") # SecurityMonitoringSignalsSort | The order of the security signals in results. (optional) page_cursor = \"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\" # str | A list of results using the cursor provided in the previous query. (optional) page_limit = 25 # int | The maximum number of security signals in the response. (optional) if omitted the server will use the default value of 10 # example passing only required values which don't have defaults set # and optional values try: # Get a quick list of security signals api_response = api_instance.list_security_monitoring_signals(filter_query=filter_query, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->list_security_monitoring_signals: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_4","text":"Name Type Description Notes filter_query str The search query for security signals. [optional] filter_from datetime The minimum timestamp for requested security signals. [optional] filter_to datetime The maximum timestamp for requested security signals. [optional] sort SecurityMonitoringSignalsSort The order of the security signals in results. [optional] page_cursor str A list of results using the cursor provided in the previous query. [optional] page_limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_4","text":"SecurityMonitoringSignalsListResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#search_security_monitoring_signals","text":"SecurityMonitoringSignalsListResponse search_security_monitoring_signals() Get a list of security signals Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing security signals.","title":"search_security_monitoring_signals"},{"location":"v2/SecurityMonitoringApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() configuration.unstable_operations[\"search_security_monitoring_signals\"] = True # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) body = SecurityMonitoringSignalListRequest( filter=SecurityMonitoringSignalListRequestFilter( _from=dateutil_parser('2019-01-02T09:42:36.32Z'), query=\"security:attack status:high\", to=dateutil_parser('2019-01-03T09:42:36.32Z'), ), page=SecurityMonitoringSignalListRequestPage( cursor=\"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==\", limit=25, ), sort=SecurityMonitoringSignalsSort(\"timestamp\"), ) # SecurityMonitoringSignalListRequest | (optional) # example passing only required values which don't have defaults set # and optional values try: # Get a list of security signals api_response = api_instance.search_security_monitoring_signals(body=body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->search_security_monitoring_signals: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_5","text":"Name Type Description Notes body SecurityMonitoringSignalListRequest [optional]","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_5","text":"SecurityMonitoringSignalsListResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_5","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Not Authorized - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringApi/#update_security_monitoring_rule","text":"SecurityMonitoringRuleResponse update_security_monitoring_rule(rule_id, body) Update an existing rule Update an existing rule. When updating cases , queries or options , the whole field must be included. For example, when modifying a query all queries must be included. Default rules can only be updated to be enabled and to change notifications.","title":"update_security_monitoring_rule"},{"location":"v2/SecurityMonitoringApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import security_monitoring_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = security_monitoring_api.SecurityMonitoringApi(api_client) rule_id = \"rule_id_example\" # str | The ID of the rule. body = SecurityMonitoringRuleUpdatePayload( cases=[ SecurityMonitoringRuleCase( condition=\"condition_example\", name=\"name_example\", notifications=[ \"notifications_example\", ], status=SecurityMonitoringRuleSeverity(\"info\"), ), ], filters=[ SecurityMonitoringFilter( action=SecurityMonitoringFilterAction(\"require\"), query=\"query_example\", ), ], is_enabled=True, message=\"message_example\", name=\"name_example\", options=SecurityMonitoringRuleOptions( detection_method=SecurityMonitoringRuleDetectionMethod(\"threshold\"), evaluation_window=SecurityMonitoringRuleEvaluationWindow(0), keep_alive=SecurityMonitoringRuleKeepAlive(0), max_signal_duration=SecurityMonitoringRuleMaxSignalDuration(0), new_value_options=SecurityMonitoringRuleNewValueOptions( forget_after=SecurityMonitoringRuleNewValueOptionsForgetAfter(1), learning_duration=SecurityMonitoringRuleNewValueOptionsLearningDuration(0), ), ), queries=[ SecurityMonitoringRuleQuery( agent_rule=SecurityMonitoringRuntimeAgentRule( agent_rule_id=\"etc_shadow\", expression=\"expression_example\", ), aggregation=SecurityMonitoringRuleQueryAggregation(\"count\"), distinct_fields=[ \"distinct_fields_example\", ], group_by_fields=[ \"group_by_fields_example\", ], metric=\"metric_example\", name=\"name_example\", query=\"query_example\", ), ], tags=[ \"tags_example\", ], ) # SecurityMonitoringRuleUpdatePayload | # example passing only required values which don't have defaults set try: # Update an existing rule api_response = api_instance.update_security_monitoring_rule(rule_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling SecurityMonitoringApi->update_security_monitoring_rule: %s\\n\" % e)","title":"Example"},{"location":"v2/SecurityMonitoringApi/#parameters_6","text":"Name Type Description Notes rule_id str The ID of the rule. body SecurityMonitoringRuleUpdatePayload","title":"Parameters"},{"location":"v2/SecurityMonitoringApi/#return-type_6","text":"SecurityMonitoringRuleResponse","title":"Return type"},{"location":"v2/SecurityMonitoringApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/SecurityMonitoringApi/#http-request-headers_6","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/SecurityMonitoringApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 401 Concurrent Modification - 403 Not Authorized - 404 Not Found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/SecurityMonitoringFilter/","text":"SecurityMonitoringFilter The rule's suppression filter. Properties Name Type Description Notes action SecurityMonitoringFilterAction [optional] query str Query for selecting logs to apply the filtering action. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringFilter"},{"location":"v2/SecurityMonitoringFilter/#securitymonitoringfilter","text":"The rule's suppression filter.","title":"SecurityMonitoringFilter"},{"location":"v2/SecurityMonitoringFilter/#properties","text":"Name Type Description Notes action SecurityMonitoringFilterAction [optional] query str Query for selecting logs to apply the filtering action. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringFilterAction/","text":"SecurityMonitoringFilterAction The type of filtering action. Properties Name Type Description Notes value str The type of filtering action. must be one of [\"require\", \"suppress\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringFilterAction"},{"location":"v2/SecurityMonitoringFilterAction/#securitymonitoringfilteraction","text":"The type of filtering action.","title":"SecurityMonitoringFilterAction"},{"location":"v2/SecurityMonitoringFilterAction/#properties","text":"Name Type Description Notes value str The type of filtering action. must be one of [\"require\", \"suppress\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringListRulesResponse/","text":"SecurityMonitoringListRulesResponse List of rules. Properties Name Type Description Notes data [SecurityMonitoringRuleResponse] TODO. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringListRulesResponse"},{"location":"v2/SecurityMonitoringListRulesResponse/#securitymonitoringlistrulesresponse","text":"List of rules.","title":"SecurityMonitoringListRulesResponse"},{"location":"v2/SecurityMonitoringListRulesResponse/#properties","text":"Name Type Description Notes data [SecurityMonitoringRuleResponse] TODO. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleCase/","text":"SecurityMonitoringRuleCase Case when signal is generated. Properties Name Type Description Notes condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] status SecurityMonitoringRuleSeverity [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleCase"},{"location":"v2/SecurityMonitoringRuleCase/#securitymonitoringrulecase","text":"Case when signal is generated.","title":"SecurityMonitoringRuleCase"},{"location":"v2/SecurityMonitoringRuleCase/#properties","text":"Name Type Description Notes condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] status SecurityMonitoringRuleSeverity [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleCaseCreate/","text":"SecurityMonitoringRuleCaseCreate Case when signal is generated. Properties Name Type Description Notes status SecurityMonitoringRuleSeverity condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleCaseCreate"},{"location":"v2/SecurityMonitoringRuleCaseCreate/#securitymonitoringrulecasecreate","text":"Case when signal is generated.","title":"SecurityMonitoringRuleCaseCreate"},{"location":"v2/SecurityMonitoringRuleCaseCreate/#properties","text":"Name Type Description Notes status SecurityMonitoringRuleSeverity condition str A rule case contains logical operations (`>`,`>=`, `&&`, ` name str Name of the case. [optional] notifications [str] Notification targets for each rule case. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleCreatePayload/","text":"SecurityMonitoringRuleCreatePayload Create a new rule. Properties Name Type Description Notes cases [SecurityMonitoringRuleCaseCreate] Cases for generating signals. is_enabled bool Whether the rule is enabled. message str Message for generated signals. name str The name of the rule. options SecurityMonitoringRuleOptions queries [SecurityMonitoringRuleQueryCreate] Queries for selecting logs which are part of the rule. filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleCreatePayload"},{"location":"v2/SecurityMonitoringRuleCreatePayload/#securitymonitoringrulecreatepayload","text":"Create a new rule.","title":"SecurityMonitoringRuleCreatePayload"},{"location":"v2/SecurityMonitoringRuleCreatePayload/#properties","text":"Name Type Description Notes cases [SecurityMonitoringRuleCaseCreate] Cases for generating signals. is_enabled bool Whether the rule is enabled. message str Message for generated signals. name str The name of the rule. options SecurityMonitoringRuleOptions queries [SecurityMonitoringRuleQueryCreate] Queries for selecting logs which are part of the rule. filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleDetectionMethod/","text":"SecurityMonitoringRuleDetectionMethod The detection method. Properties Name Type Description Notes value str The detection method. must be one of [\"threshold\", \"new_value\", \"anomaly_detection\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleDetectionMethod"},{"location":"v2/SecurityMonitoringRuleDetectionMethod/#securitymonitoringruledetectionmethod","text":"The detection method.","title":"SecurityMonitoringRuleDetectionMethod"},{"location":"v2/SecurityMonitoringRuleDetectionMethod/#properties","text":"Name Type Description Notes value str The detection method. must be one of [\"threshold\", \"new_value\", \"anomaly_detection\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleEvaluationWindow/","text":"SecurityMonitoringRuleEvaluationWindow A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. Properties Name Type Description Notes value int A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleEvaluationWindow"},{"location":"v2/SecurityMonitoringRuleEvaluationWindow/#securitymonitoringruleevaluationwindow","text":"A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time.","title":"SecurityMonitoringRuleEvaluationWindow"},{"location":"v2/SecurityMonitoringRuleEvaluationWindow/#properties","text":"Name Type Description Notes value int A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleKeepAlive/","text":"SecurityMonitoringRuleKeepAlive Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window. Properties Name Type Description Notes value int Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleKeepAlive"},{"location":"v2/SecurityMonitoringRuleKeepAlive/#securitymonitoringrulekeepalive","text":"Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window.","title":"SecurityMonitoringRuleKeepAlive"},{"location":"v2/SecurityMonitoringRuleKeepAlive/#properties","text":"Name Type Description Notes value int Once a signal is generated, the signal will remain \u201copen\u201d if a case is matched at least once within this keep alive window. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleMaxSignalDuration/","text":"SecurityMonitoringRuleMaxSignalDuration A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. Properties Name Type Description Notes value int A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleMaxSignalDuration"},{"location":"v2/SecurityMonitoringRuleMaxSignalDuration/#securitymonitoringrulemaxsignalduration","text":"A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.","title":"SecurityMonitoringRuleMaxSignalDuration"},{"location":"v2/SecurityMonitoringRuleMaxSignalDuration/#properties","text":"Name Type Description Notes value int A signal will \u201cclose\u201d regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleNewValueOptions/","text":"SecurityMonitoringRuleNewValueOptions Options on new value rules. Properties Name Type Description Notes forget_after SecurityMonitoringRuleNewValueOptionsForgetAfter [optional] learning_duration SecurityMonitoringRuleNewValueOptionsLearningDuration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleNewValueOptions"},{"location":"v2/SecurityMonitoringRuleNewValueOptions/#securitymonitoringrulenewvalueoptions","text":"Options on new value rules.","title":"SecurityMonitoringRuleNewValueOptions"},{"location":"v2/SecurityMonitoringRuleNewValueOptions/#properties","text":"Name Type Description Notes forget_after SecurityMonitoringRuleNewValueOptionsForgetAfter [optional] learning_duration SecurityMonitoringRuleNewValueOptionsLearningDuration [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/","text":"SecurityMonitoringRuleNewValueOptionsForgetAfter The duration in days after which a learned value is forgotten. Properties Name Type Description Notes value int The duration in days after which a learned value is forgotten. must be one of [1, 2, 7, 14, 21, 28, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleNewValueOptionsForgetAfter"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/#securitymonitoringrulenewvalueoptionsforgetafter","text":"The duration in days after which a learned value is forgotten.","title":"SecurityMonitoringRuleNewValueOptionsForgetAfter"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/#properties","text":"Name Type Description Notes value int The duration in days after which a learned value is forgotten. must be one of [1, 2, 7, 14, 21, 28, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/","text":"SecurityMonitoringRuleNewValueOptionsLearningDuration The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. Properties Name Type Description Notes value int The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. must be one of [0, 1, 7, ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleNewValueOptionsLearningDuration"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/#securitymonitoringrulenewvalueoptionslearningduration","text":"The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.","title":"SecurityMonitoringRuleNewValueOptionsLearningDuration"},{"location":"v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/#properties","text":"Name Type Description Notes value int The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. must be one of [0, 1, 7, ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleOptions/","text":"SecurityMonitoringRuleOptions Options on rules. Properties Name Type Description Notes detection_method SecurityMonitoringRuleDetectionMethod [optional] evaluation_window SecurityMonitoringRuleEvaluationWindow [optional] keep_alive SecurityMonitoringRuleKeepAlive [optional] max_signal_duration SecurityMonitoringRuleMaxSignalDuration [optional] new_value_options SecurityMonitoringRuleNewValueOptions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleOptions"},{"location":"v2/SecurityMonitoringRuleOptions/#securitymonitoringruleoptions","text":"Options on rules.","title":"SecurityMonitoringRuleOptions"},{"location":"v2/SecurityMonitoringRuleOptions/#properties","text":"Name Type Description Notes detection_method SecurityMonitoringRuleDetectionMethod [optional] evaluation_window SecurityMonitoringRuleEvaluationWindow [optional] keep_alive SecurityMonitoringRuleKeepAlive [optional] max_signal_duration SecurityMonitoringRuleMaxSignalDuration [optional] new_value_options SecurityMonitoringRuleNewValueOptions [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleQuery/","text":"SecurityMonitoringRuleQuery Query for matching rule. Properties Name Type Description Notes agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] query str Query to run on logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleQuery"},{"location":"v2/SecurityMonitoringRuleQuery/#securitymonitoringrulequery","text":"Query for matching rule.","title":"SecurityMonitoringRuleQuery"},{"location":"v2/SecurityMonitoringRuleQuery/#properties","text":"Name Type Description Notes agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] query str Query to run on logs. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleQueryAggregation/","text":"SecurityMonitoringRuleQueryAggregation The aggregation type. Properties Name Type Description Notes value str The aggregation type. must be one of [\"count\", \"cardinality\", \"sum\", \"max\", \"new_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleQueryAggregation"},{"location":"v2/SecurityMonitoringRuleQueryAggregation/#securitymonitoringrulequeryaggregation","text":"The aggregation type.","title":"SecurityMonitoringRuleQueryAggregation"},{"location":"v2/SecurityMonitoringRuleQueryAggregation/#properties","text":"Name Type Description Notes value str The aggregation type. must be one of [\"count\", \"cardinality\", \"sum\", \"max\", \"new_value\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleQueryCreate/","text":"SecurityMonitoringRuleQueryCreate Query for matching rule. Properties Name Type Description Notes query str Query to run on logs. agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleQueryCreate"},{"location":"v2/SecurityMonitoringRuleQueryCreate/#securitymonitoringrulequerycreate","text":"Query for matching rule.","title":"SecurityMonitoringRuleQueryCreate"},{"location":"v2/SecurityMonitoringRuleQueryCreate/#properties","text":"Name Type Description Notes query str Query to run on logs. agent_rule SecurityMonitoringRuntimeAgentRule [optional] aggregation SecurityMonitoringRuleQueryAggregation [optional] distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional] group_by_fields [str] Fields to group by. [optional] metric str The target field to aggregate over when using the sum or max aggregations. [optional] name str Name of the query. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleResponse/","text":"SecurityMonitoringRuleResponse Detection rule. Properties Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] created_at int When the rule was created, timestamp in milliseconds. [optional] creation_author_id int User ID of the user who created the rule. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] id str The ID of the rule. [optional] is_default bool Whether the rule is included by default. [optional] is_deleted bool Whether the rule has been deleted. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str The name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] version int The version of the rule. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleResponse"},{"location":"v2/SecurityMonitoringRuleResponse/#securitymonitoringruleresponse","text":"Detection rule.","title":"SecurityMonitoringRuleResponse"},{"location":"v2/SecurityMonitoringRuleResponse/#properties","text":"Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] created_at int When the rule was created, timestamp in milliseconds. [optional] creation_author_id int User ID of the user who created the rule. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] id str The ID of the rule. [optional] is_default bool Whether the rule is included by default. [optional] is_deleted bool Whether the rule has been deleted. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str The name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] version int The version of the rule. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleSeverity/","text":"SecurityMonitoringRuleSeverity Severity of the Security Signal. Properties Name Type Description Notes value str Severity of the Security Signal. must be one of [\"info\", \"low\", \"medium\", \"high\", \"critical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleSeverity"},{"location":"v2/SecurityMonitoringRuleSeverity/#securitymonitoringruleseverity","text":"Severity of the Security Signal.","title":"SecurityMonitoringRuleSeverity"},{"location":"v2/SecurityMonitoringRuleSeverity/#properties","text":"Name Type Description Notes value str Severity of the Security Signal. must be one of [\"info\", \"low\", \"medium\", \"high\", \"critical\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuleUpdatePayload/","text":"SecurityMonitoringRuleUpdatePayload Update an existing rule. Properties Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str Name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuleUpdatePayload"},{"location":"v2/SecurityMonitoringRuleUpdatePayload/#securitymonitoringruleupdatepayload","text":"Update an existing rule.","title":"SecurityMonitoringRuleUpdatePayload"},{"location":"v2/SecurityMonitoringRuleUpdatePayload/#properties","text":"Name Type Description Notes cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional] filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional] is_enabled bool Whether the rule is enabled. [optional] message str Message for generated signals. [optional] name str Name of the rule. [optional] options SecurityMonitoringRuleOptions [optional] queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional] tags [str] Tags for generated signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringRuntimeAgentRule/","text":"SecurityMonitoringRuntimeAgentRule The Agent rule. Properties Name Type Description Notes agent_rule_id str The Agent rule ID. Must be unique within the rule. [optional] expression str 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] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringRuntimeAgentRule"},{"location":"v2/SecurityMonitoringRuntimeAgentRule/#securitymonitoringruntimeagentrule","text":"The Agent rule.","title":"SecurityMonitoringRuntimeAgentRule"},{"location":"v2/SecurityMonitoringRuntimeAgentRule/#properties","text":"Name Type Description Notes agent_rule_id str The Agent rule ID. Must be unique within the rule. [optional] expression str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignal/","text":"SecurityMonitoringSignal Object description of a security signal. Properties Name Type Description Notes attributes SecurityMonitoringSignalAttributes [optional] id str The unique ID of the security signal. [optional] type SecurityMonitoringSignalType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignal"},{"location":"v2/SecurityMonitoringSignal/#securitymonitoringsignal","text":"Object description of a security signal.","title":"SecurityMonitoringSignal"},{"location":"v2/SecurityMonitoringSignal/#properties","text":"Name Type Description Notes attributes SecurityMonitoringSignalAttributes [optional] id str The unique ID of the security signal. [optional] type SecurityMonitoringSignalType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalAttributes/","text":"SecurityMonitoringSignalAttributes The object containing all signal attributes and their associated values. Properties Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} A JSON object of attributes in the security signal. [optional] message str The message in the security signal defined by the rule that generated the signal. [optional] tags [bool, date, datetime, dict, float, int, list, str, none_type] An array of tags associated with the security signal. [optional] timestamp datetime The timestamp of the security signal. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalAttributes"},{"location":"v2/SecurityMonitoringSignalAttributes/#securitymonitoringsignalattributes","text":"The object containing all signal attributes and their associated values.","title":"SecurityMonitoringSignalAttributes"},{"location":"v2/SecurityMonitoringSignalAttributes/#properties","text":"Name Type Description Notes attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} A JSON object of attributes in the security signal. [optional] message str The message in the security signal defined by the rule that generated the signal. [optional] tags [bool, date, datetime, dict, float, int, list, str, none_type] An array of tags associated with the security signal. [optional] timestamp datetime The timestamp of the security signal. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalListRequest/","text":"SecurityMonitoringSignalListRequest The request for a security signal list. Properties Name Type Description Notes filter SecurityMonitoringSignalListRequestFilter [optional] page SecurityMonitoringSignalListRequestPage [optional] sort SecurityMonitoringSignalsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalListRequest"},{"location":"v2/SecurityMonitoringSignalListRequest/#securitymonitoringsignallistrequest","text":"The request for a security signal list.","title":"SecurityMonitoringSignalListRequest"},{"location":"v2/SecurityMonitoringSignalListRequest/#properties","text":"Name Type Description Notes filter SecurityMonitoringSignalListRequestFilter [optional] page SecurityMonitoringSignalListRequestPage [optional] sort SecurityMonitoringSignalsSort [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalListRequestFilter/","text":"SecurityMonitoringSignalListRequestFilter Search filters for listing security signals. Properties Name Type Description Notes _from datetime The minimum timestamp for requested security signals. [optional] query str Search query for listing security signals. [optional] to datetime The maximum timestamp for requested security signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalListRequestFilter"},{"location":"v2/SecurityMonitoringSignalListRequestFilter/#securitymonitoringsignallistrequestfilter","text":"Search filters for listing security signals.","title":"SecurityMonitoringSignalListRequestFilter"},{"location":"v2/SecurityMonitoringSignalListRequestFilter/#properties","text":"Name Type Description Notes _from datetime The minimum timestamp for requested security signals. [optional] query str Search query for listing security signals. [optional] to datetime The maximum timestamp for requested security signals. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalListRequestPage/","text":"SecurityMonitoringSignalListRequestPage The paging attributes for listing security signals. Properties Name Type Description Notes cursor str A list of results using the cursor provided in the previous query. [optional] limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalListRequestPage"},{"location":"v2/SecurityMonitoringSignalListRequestPage/#securitymonitoringsignallistrequestpage","text":"The paging attributes for listing security signals.","title":"SecurityMonitoringSignalListRequestPage"},{"location":"v2/SecurityMonitoringSignalListRequestPage/#properties","text":"Name Type Description Notes cursor str A list of results using the cursor provided in the previous query. [optional] limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10 [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalType/","text":"SecurityMonitoringSignalType The type of event. Properties Name Type Description Notes value str The type of event. defaults to \"signal\", must be one of [\"signal\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalType"},{"location":"v2/SecurityMonitoringSignalType/#securitymonitoringsignaltype","text":"The type of event.","title":"SecurityMonitoringSignalType"},{"location":"v2/SecurityMonitoringSignalType/#properties","text":"Name Type Description Notes value str The type of event. defaults to \"signal\", must be one of [\"signal\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponse/","text":"SecurityMonitoringSignalsListResponse The response object with all security signals matching the request and pagination information. Properties Name Type Description Notes data [SecurityMonitoringSignal] An array of security signals matching the request. [optional] links SecurityMonitoringSignalsListResponseLinks [optional] meta SecurityMonitoringSignalsListResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponse"},{"location":"v2/SecurityMonitoringSignalsListResponse/#securitymonitoringsignalslistresponse","text":"The response object with all security signals matching the request and pagination information.","title":"SecurityMonitoringSignalsListResponse"},{"location":"v2/SecurityMonitoringSignalsListResponse/#properties","text":"Name Type Description Notes data [SecurityMonitoringSignal] An array of security signals matching the request. [optional] links SecurityMonitoringSignalsListResponseLinks [optional] meta SecurityMonitoringSignalsListResponseMeta [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponseLinks/","text":"SecurityMonitoringSignalsListResponseLinks Links attributes. Properties Name Type Description Notes next str The link for the next set of results. Note : The request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponseLinks"},{"location":"v2/SecurityMonitoringSignalsListResponseLinks/#securitymonitoringsignalslistresponselinks","text":"Links attributes.","title":"SecurityMonitoringSignalsListResponseLinks"},{"location":"v2/SecurityMonitoringSignalsListResponseLinks/#properties","text":"Name Type Description Notes next str The link for the next set of results. Note : The request can also be made using the POST endpoint. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponseMeta/","text":"SecurityMonitoringSignalsListResponseMeta Meta attributes. Properties Name Type Description Notes page SecurityMonitoringSignalsListResponseMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponseMeta"},{"location":"v2/SecurityMonitoringSignalsListResponseMeta/#securitymonitoringsignalslistresponsemeta","text":"Meta attributes.","title":"SecurityMonitoringSignalsListResponseMeta"},{"location":"v2/SecurityMonitoringSignalsListResponseMeta/#properties","text":"Name Type Description Notes page SecurityMonitoringSignalsListResponseMetaPage [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsListResponseMetaPage/","text":"SecurityMonitoringSignalsListResponseMetaPage Paging attributes. Properties Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsListResponseMetaPage"},{"location":"v2/SecurityMonitoringSignalsListResponseMetaPage/#securitymonitoringsignalslistresponsemetapage","text":"Paging attributes.","title":"SecurityMonitoringSignalsListResponseMetaPage"},{"location":"v2/SecurityMonitoringSignalsListResponseMetaPage/#properties","text":"Name Type Description Notes after str 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] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/SecurityMonitoringSignalsSort/","text":"SecurityMonitoringSignalsSort The sort parameters used for querying security signals. Properties Name Type Description Notes value str The sort parameters used for querying security signals. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"SecurityMonitoringSignalsSort"},{"location":"v2/SecurityMonitoringSignalsSort/#securitymonitoringsignalssort","text":"The sort parameters used for querying security signals.","title":"SecurityMonitoringSignalsSort"},{"location":"v2/SecurityMonitoringSignalsSort/#properties","text":"Name Type Description Notes value str The sort parameters used for querying security signals. must be one of [\"timestamp\", \"-timestamp\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/User/","text":"User User object returned by the API. Properties Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"User"},{"location":"v2/User/#user","text":"User object returned by the API.","title":"User"},{"location":"v2/User/#properties","text":"Name Type Description Notes attributes UserAttributes [optional] id str ID of the user. [optional] relationships UserResponseRelationships [optional] type UsersType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserAttributes/","text":"UserAttributes Attributes of user object returned by the API. Properties Name Type Description Notes created_at datetime Creation time of the user. [optional] disabled bool Whether the user is disabled. [optional] email str Email of the user. [optional] handle str Handle of the user. [optional] icon str URL of the user's icon. [optional] modified_at datetime Time that the user was last modified. [optional] name str Name of the user. [optional] status str Status of the user. [optional] title str Title of the user. [optional] verified bool Whether the user is verified. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserAttributes"},{"location":"v2/UserAttributes/#userattributes","text":"Attributes of user object returned by the API.","title":"UserAttributes"},{"location":"v2/UserAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the user. [optional] disabled bool Whether the user is disabled. [optional] email str Email of the user. [optional] handle str Handle of the user. [optional] icon str URL of the user's icon. [optional] modified_at datetime Time that the user was last modified. [optional] name str Name of the user. [optional] status str Status of the user. [optional] title str Title of the user. [optional] verified bool Whether the user is verified. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserCreateAttributes/","text":"UserCreateAttributes Attributes of the created user. Properties Name Type Description Notes email str The email of the user. name str The name of the user. [optional] title str The title of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserCreateAttributes"},{"location":"v2/UserCreateAttributes/#usercreateattributes","text":"Attributes of the created user.","title":"UserCreateAttributes"},{"location":"v2/UserCreateAttributes/#properties","text":"Name Type Description Notes email str The email of the user. name str The name of the user. [optional] title str The title of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserCreateData/","text":"UserCreateData Object to create a user. Properties Name Type Description Notes attributes UserCreateAttributes type UsersType relationships UserRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserCreateData"},{"location":"v2/UserCreateData/#usercreatedata","text":"Object to create a user.","title":"UserCreateData"},{"location":"v2/UserCreateData/#properties","text":"Name Type Description Notes attributes UserCreateAttributes type UsersType relationships UserRelationships [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserCreateRequest/","text":"UserCreateRequest Create a user. Properties Name Type Description Notes data UserCreateData [Back to Model list] [Back to API list] [Back to README]","title":"UserCreateRequest"},{"location":"v2/UserCreateRequest/#usercreaterequest","text":"Create a user.","title":"UserCreateRequest"},{"location":"v2/UserCreateRequest/#properties","text":"Name Type Description Notes data UserCreateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationData/","text":"UserInvitationData Object to create a user invitation. Properties Name Type Description Notes relationships UserInvitationRelationships type UserInvitationsType [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationData"},{"location":"v2/UserInvitationData/#userinvitationdata","text":"Object to create a user invitation.","title":"UserInvitationData"},{"location":"v2/UserInvitationData/#properties","text":"Name Type Description Notes relationships UserInvitationRelationships type UserInvitationsType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationDataAttributes/","text":"UserInvitationDataAttributes Attributes of a user invitation. Properties Name Type Description Notes created_at datetime Creation time of the user invitation. [optional] expires_at datetime Time of invitation expiration. [optional] invite_type str Type of invitation. [optional] uuid str UUID of the user invitation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationDataAttributes"},{"location":"v2/UserInvitationDataAttributes/#userinvitationdataattributes","text":"Attributes of a user invitation.","title":"UserInvitationDataAttributes"},{"location":"v2/UserInvitationDataAttributes/#properties","text":"Name Type Description Notes created_at datetime Creation time of the user invitation. [optional] expires_at datetime Time of invitation expiration. [optional] invite_type str Type of invitation. [optional] uuid str UUID of the user invitation. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationRelationships/","text":"UserInvitationRelationships Relationships data for user invitation. Properties Name Type Description Notes user RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationRelationships"},{"location":"v2/UserInvitationRelationships/#userinvitationrelationships","text":"Relationships data for user invitation.","title":"UserInvitationRelationships"},{"location":"v2/UserInvitationRelationships/#properties","text":"Name Type Description Notes user RelationshipToUser [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationResponse/","text":"UserInvitationResponse User invitation as returned by the API. Properties Name Type Description Notes data UserInvitationResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationResponse"},{"location":"v2/UserInvitationResponse/#userinvitationresponse","text":"User invitation as returned by the API.","title":"UserInvitationResponse"},{"location":"v2/UserInvitationResponse/#properties","text":"Name Type Description Notes data UserInvitationResponseData [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationResponseData/","text":"UserInvitationResponseData Object of a user invitation returned by the API. Properties Name Type Description Notes attributes UserInvitationDataAttributes [optional] id str ID of the user invitation. [optional] type UserInvitationsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationResponseData"},{"location":"v2/UserInvitationResponseData/#userinvitationresponsedata","text":"Object of a user invitation returned by the API.","title":"UserInvitationResponseData"},{"location":"v2/UserInvitationResponseData/#properties","text":"Name Type Description Notes attributes UserInvitationDataAttributes [optional] id str ID of the user invitation. [optional] type UserInvitationsType [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationsRequest/","text":"UserInvitationsRequest Object to invite users to join the organization. Properties Name Type Description Notes data [UserInvitationData] List of user invitations. [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationsRequest"},{"location":"v2/UserInvitationsRequest/#userinvitationsrequest","text":"Object to invite users to join the organization.","title":"UserInvitationsRequest"},{"location":"v2/UserInvitationsRequest/#properties","text":"Name Type Description Notes data [UserInvitationData] List of user invitations. [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationsResponse/","text":"UserInvitationsResponse User invitations as returned by the API. Properties Name Type Description Notes data [UserInvitationResponseData] Array of user invitations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationsResponse"},{"location":"v2/UserInvitationsResponse/#userinvitationsresponse","text":"User invitations as returned by the API.","title":"UserInvitationsResponse"},{"location":"v2/UserInvitationsResponse/#properties","text":"Name Type Description Notes data [UserInvitationResponseData] Array of user invitations. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserInvitationsType/","text":"UserInvitationsType User invitations type. Properties Name Type Description Notes value str User invitations type. defaults to \"user_invitations\", must be one of [\"user_invitations\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UserInvitationsType"},{"location":"v2/UserInvitationsType/#userinvitationstype","text":"User invitations type.","title":"UserInvitationsType"},{"location":"v2/UserInvitationsType/#properties","text":"Name Type Description Notes value str User invitations type. defaults to \"user_invitations\", must be one of [\"user_invitations\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserRelationships/","text":"UserRelationships Relationships of the user object. Properties Name Type Description Notes roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserRelationships"},{"location":"v2/UserRelationships/#userrelationships","text":"Relationships of the user object.","title":"UserRelationships"},{"location":"v2/UserRelationships/#properties","text":"Name Type Description Notes roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserResponse/","text":"UserResponse Response containing information about a single user. Properties Name Type Description Notes data User [optional] included [UserResponseIncludedItem] Array of objects related to the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponse"},{"location":"v2/UserResponse/#userresponse","text":"Response containing information about a single user.","title":"UserResponse"},{"location":"v2/UserResponse/#properties","text":"Name Type Description Notes data User [optional] included [UserResponseIncludedItem] Array of objects related to the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserResponseIncludedItem/","text":"UserResponseIncludedItem An object related to a user. Properties Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponseIncludedItem"},{"location":"v2/UserResponseIncludedItem/#userresponseincludeditem","text":"An object related to a user.","title":"UserResponseIncludedItem"},{"location":"v2/UserResponseIncludedItem/#properties","text":"Name Type Description Notes attributes RoleAttributes [optional] id str ID of the role. [optional] relationships RoleResponseRelationships [optional] type RolesType [optional] any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserResponseRelationships/","text":"UserResponseRelationships Relationships of the user object returned by the API. Properties Name Type Description Notes org RelationshipToOrganization [optional] other_orgs RelationshipToOrganizations [optional] other_users RelationshipToUsers [optional] roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserResponseRelationships"},{"location":"v2/UserResponseRelationships/#userresponserelationships","text":"Relationships of the user object returned by the API.","title":"UserResponseRelationships"},{"location":"v2/UserResponseRelationships/#properties","text":"Name Type Description Notes org RelationshipToOrganization [optional] other_orgs RelationshipToOrganizations [optional] other_users RelationshipToUsers [optional] roles RelationshipToRoles [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserUpdateAttributes/","text":"UserUpdateAttributes Attributes of the edited user. Properties Name Type Description Notes disabled bool If the user is enabled or disabled. [optional] email str The email of the user. [optional] name str The name of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UserUpdateAttributes"},{"location":"v2/UserUpdateAttributes/#userupdateattributes","text":"Attributes of the edited user.","title":"UserUpdateAttributes"},{"location":"v2/UserUpdateAttributes/#properties","text":"Name Type Description Notes disabled bool If the user is enabled or disabled. [optional] email str The email of the user. [optional] name str The name of the user. [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserUpdateData/","text":"UserUpdateData Object to update a user. Properties Name Type Description Notes attributes UserUpdateAttributes id str ID of the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"UserUpdateData"},{"location":"v2/UserUpdateData/#userupdatedata","text":"Object to update a user.","title":"UserUpdateData"},{"location":"v2/UserUpdateData/#properties","text":"Name Type Description Notes attributes UserUpdateAttributes id str ID of the user. type UsersType [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UserUpdateRequest/","text":"UserUpdateRequest Update a user. Properties Name Type Description Notes data UserUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"UserUpdateRequest"},{"location":"v2/UserUpdateRequest/#userupdaterequest","text":"Update a user.","title":"UserUpdateRequest"},{"location":"v2/UserUpdateRequest/#properties","text":"Name Type Description Notes data UserUpdateData [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UsersApi/","text":"datadog_api_client.v2.UsersApi All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v2/users Create a user disable_user DELETE /api/v2/users/{user_id} Disable a user get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation get_user GET /api/v2/users/{user_id} Get user details list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions list_users GET /api/v2/users List all users send_invitations POST /api/v2/user_invitations Send invitation emails update_user PATCH /api/v2/users/{user_id} Update a user create_user UserResponse create_user(body) Create a user Create a user for your organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserCreateRequest( data=UserCreateData( attributes=UserCreateAttributes( email=\"jane.doe@example.com\", name=\"name_example\", title=\"title_example\", ), relationships=UserRelationships( roles=RelationshipToRoles( data=[ RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ], ), ), type=UsersType(\"users\"), ), ) # UserCreateRequest | # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e) Parameters Name Type Description Notes body UserCreateRequest Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] disable_user disable_user(user_id) Disable a user Disable a user. Can only be used with an application key belonging to an administrator user. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Disable a user api_instance.disable_user(user_id) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type void (empty response body) Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_invitation UserInvitationResponse get_invitation(user_invitation_uuid) Get a user invitation Returns a single user invitation by its UUID. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_invitation_uuid = \"user_invitation_uuid_example\" # str | The UUID of the user invitation. # example passing only required values which don't have defaults set try: # Get a user invitation api_response = api_instance.get_invitation(user_invitation_uuid) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_invitation: %s\\n\" % e) Parameters Name Type Description Notes user_invitation_uuid str The UUID of the user invitation. Return type UserInvitationResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] get_user UserResponse get_user(user_id) Get user details Get a user in the organization specified by the user\u2019s user_id . Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_user_organizations UserResponse list_user_organizations(user_id) Get a user organization Get a user organization. Returns the user information and all organizations joined by this user. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user organization api_response = api_instance.list_user_organizations(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_organizations: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_user_permissions PermissionsResponse list_user_permissions(user_id) Get a user permissions Get a user permission set. Returns a list of the user\u2019s permissions granted by the associated user's roles. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user permissions api_response = api_instance.list_user_permissions(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_permissions: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. Return type PermissionsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README] list_users UsersResponse list_users() List all users Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" sort_dir = QuerySortOrder(\"desc\") # QuerySortOrder | Direction of sort. Options: `asc`, `desc`. (optional) filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) filter_status = \"filter[status]_example\" # str | Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all users api_response = api_instance.list_users(page_size=page_size, page_number=page_number, sort=sort, sort_dir=sort_dir, filter=filter, filter_status=filter_status) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e) Parameters Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" sort_dir QuerySortOrder Direction of sort. Options: `asc`, `desc`. [optional] filter str Filter all users by the given string. Defaults to no filtering. [optional] filter_status str Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. [optional] Return type UsersResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : Not defined Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] send_invitations UserInvitationsResponse send_invitations(body) Send invitation emails Sends emails to one or more users inviting them to join the organization. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserInvitationsRequest( data=[ UserInvitationData( relationships=UserInvitationRelationships( user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=UserInvitationsType(\"user_invitations\"), ), ], ) # UserInvitationsRequest | # example passing only required values which don't have defaults set try: # Send invitation emails api_response = api_instance.send_invitations(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->send_invitations: %s\\n\" % e) Parameters Name Type Description Notes body UserInvitationsRequest Return type UserInvitationsResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README] update_user UserResponse update_user(user_id, body) Update a user Edit a user. Can only be used with an application key belonging to an administrator user. Example Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. body = UserUpdateRequest( data=UserUpdateData( attributes=UserUpdateAttributes( disabled=True, email=\"email_example\", name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # UserUpdateRequest | # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e) Parameters Name Type Description Notes user_id str The ID of the user. body UserUpdateRequest Return type UserResponse Authorization apiKeyAuth , appKeyAuth HTTP request headers Content-Type : application/json Accept : application/json HTTP response details Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"datadog_api_client.v2.UsersApi"},{"location":"v2/UsersApi/#datadog_api_clientv2usersapi","text":"All URIs are relative to https://api.datadoghq.com Method HTTP request Description create_user POST /api/v2/users Create a user disable_user DELETE /api/v2/users/{user_id} Disable a user get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation get_user GET /api/v2/users/{user_id} Get user details list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions list_users GET /api/v2/users List all users send_invitations POST /api/v2/user_invitations Send invitation emails update_user PATCH /api/v2/users/{user_id} Update a user","title":"datadog_api_client.v2.UsersApi"},{"location":"v2/UsersApi/#create_user","text":"UserResponse create_user(body) Create a user Create a user for your organization.","title":"create_user"},{"location":"v2/UsersApi/#example","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserCreateRequest( data=UserCreateData( attributes=UserCreateAttributes( email=\"jane.doe@example.com\", name=\"name_example\", title=\"title_example\", ), relationships=UserRelationships( roles=RelationshipToRoles( data=[ RelationshipToRoleData( id=\"3653d3c6-0c75-11ea-ad28-fb5701eabc7d\", type=RolesType(\"roles\"), ), ], ), ), type=UsersType(\"users\"), ), ) # UserCreateRequest | # example passing only required values which don't have defaults set try: # Create a user api_response = api_instance.create_user(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->create_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters","text":"Name Type Description Notes body UserCreateRequest","title":"Parameters"},{"location":"v2/UsersApi/#return-type","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details","text":"Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#disable_user","text":"disable_user(user_id) Disable a user Disable a user. Can only be used with an application key belonging to an administrator user.","title":"disable_user"},{"location":"v2/UsersApi/#example_1","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Disable a user api_instance.disable_user(user_id) except ApiException as e: print(\"Exception when calling UsersApi->disable_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_1","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_1","text":"void (empty response body)","title":"Return type"},{"location":"v2/UsersApi/#authorization_1","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_1","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_1","text":"Status code Description Response headers 204 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#get_invitation","text":"UserInvitationResponse get_invitation(user_invitation_uuid) Get a user invitation Returns a single user invitation by its UUID.","title":"get_invitation"},{"location":"v2/UsersApi/#example_2","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_invitation_uuid = \"user_invitation_uuid_example\" # str | The UUID of the user invitation. # example passing only required values which don't have defaults set try: # Get a user invitation api_response = api_instance.get_invitation(user_invitation_uuid) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_invitation: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_2","text":"Name Type Description Notes user_invitation_uuid str The UUID of the user invitation.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_2","text":"UserInvitationResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_2","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_2","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_2","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#get_user","text":"UserResponse get_user(user_id) Get user details Get a user in the organization specified by the user\u2019s user_id .","title":"get_user"},{"location":"v2/UsersApi/#example_3","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get user details api_response = api_instance.get_user(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->get_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_3","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_3","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_3","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_3","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_3","text":"Status code Description Response headers 200 OK for get user - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#list_user_organizations","text":"UserResponse list_user_organizations(user_id) Get a user organization Get a user organization. Returns the user information and all organizations joined by this user.","title":"list_user_organizations"},{"location":"v2/UsersApi/#example_4","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user organization api_response = api_instance.list_user_organizations(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_organizations: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_4","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_4","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_4","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_4","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_4","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#list_user_permissions","text":"PermissionsResponse list_user_permissions(user_id) Get a user permissions Get a user permission set. Returns a list of the user\u2019s permissions granted by the associated user's roles.","title":"list_user_permissions"},{"location":"v2/UsersApi/#example_5","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. # example passing only required values which don't have defaults set try: # Get a user permissions api_response = api_instance.list_user_permissions(user_id) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_user_permissions: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_5","text":"Name Type Description Notes user_id str The ID of the user.","title":"Parameters"},{"location":"v2/UsersApi/#return-type_5","text":"PermissionsResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_5","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_5","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_5","text":"Status code Description Response headers 200 OK - 403 Authentication error - 404 Not found - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#list_users","text":"UsersResponse list_users() List all users Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.","title":"list_users"},{"location":"v2/UsersApi/#example_6","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) page_size = 10 # int | Size for a given page. (optional) if omitted the server will use the default value of 10 page_number = 0 # int | Specific page number to return. (optional) if omitted the server will use the default value of 0 sort = \"name\" # str | 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) if omitted the server will use the default value of \"name\" sort_dir = QuerySortOrder(\"desc\") # QuerySortOrder | Direction of sort. Options: `asc`, `desc`. (optional) filter = \"filter_example\" # str | Filter all users by the given string. Defaults to no filtering. (optional) filter_status = \"filter[status]_example\" # str | Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. (optional) # example passing only required values which don't have defaults set # and optional values try: # List all users api_response = api_instance.list_users(page_size=page_size, page_number=page_number, sort=sort, sort_dir=sort_dir, filter=filter, filter_status=filter_status) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->list_users: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_6","text":"Name Type Description Notes page_size int Size for a given page. [optional] if omitted the server will use the default value of 10 page_number int Specific page number to return. [optional] if omitted the server will use the default value of 0 sort str 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] if omitted the server will use the default value of \"name\" sort_dir QuerySortOrder Direction of sort. Options: `asc`, `desc`. [optional] filter str Filter all users by the given string. Defaults to no filtering. [optional] filter_status str Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. [optional]","title":"Parameters"},{"location":"v2/UsersApi/#return-type_6","text":"UsersResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_6","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_6","text":"Content-Type : Not defined Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_6","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#send_invitations","text":"UserInvitationsResponse send_invitations(body) Send invitation emails Sends emails to one or more users inviting them to join the organization.","title":"send_invitations"},{"location":"v2/UsersApi/#example_7","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) body = UserInvitationsRequest( data=[ UserInvitationData( relationships=UserInvitationRelationships( user=RelationshipToUser( data=RelationshipToUserData( id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ), ), type=UserInvitationsType(\"user_invitations\"), ), ], ) # UserInvitationsRequest | # example passing only required values which don't have defaults set try: # Send invitation emails api_response = api_instance.send_invitations(body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->send_invitations: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_7","text":"Name Type Description Notes body UserInvitationsRequest","title":"Parameters"},{"location":"v2/UsersApi/#return-type_7","text":"UserInvitationsResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_7","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_7","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_7","text":"Status code Description Response headers 201 OK - 400 Bad Request - 403 Authentication error - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersApi/#update_user","text":"UserResponse update_user(user_id, body) Update a user Edit a user. Can only be used with an application key belonging to an administrator user.","title":"update_user"},{"location":"v2/UsersApi/#example_8","text":"Api Key Authentication (apiKeyAuth): Api Key Authentication (appKeyAuth): import os from dateutil.parser import parse as dateutil_parser from datadog_api_client.v2 import ApiClient, ApiException, Configuration from datadog_api_client.v2.api import users_api from datadog_api_client.v2.models import * from pprint import pprint # See configuration.py for a list of all supported configuration parameters. configuration = Configuration() # Enter a context with an instance of the API client with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) user_id = \"user_id_example\" # str | The ID of the user. body = UserUpdateRequest( data=UserUpdateData( attributes=UserUpdateAttributes( disabled=True, email=\"email_example\", name=\"name_example\", ), id=\"00000000-0000-0000-0000-000000000000\", type=UsersType(\"users\"), ), ) # UserUpdateRequest | # example passing only required values which don't have defaults set try: # Update a user api_response = api_instance.update_user(user_id, body) pprint(api_response) except ApiException as e: print(\"Exception when calling UsersApi->update_user: %s\\n\" % e)","title":"Example"},{"location":"v2/UsersApi/#parameters_8","text":"Name Type Description Notes user_id str The ID of the user. body UserUpdateRequest","title":"Parameters"},{"location":"v2/UsersApi/#return-type_8","text":"UserResponse","title":"Return type"},{"location":"v2/UsersApi/#authorization_8","text":"apiKeyAuth , appKeyAuth","title":"Authorization"},{"location":"v2/UsersApi/#http-request-headers_8","text":"Content-Type : application/json Accept : application/json","title":"HTTP request headers"},{"location":"v2/UsersApi/#http-response-details_8","text":"Status code Description Response headers 200 OK - 400 Bad Request - 403 Authentication error - 404 Not found - 422 Unprocessable Entity - [Back to top] [Back to API list] [Back to Model list] [Back to README]","title":"HTTP response details"},{"location":"v2/UsersResponse/","text":"UsersResponse Response containing information about multiple users. Properties Name Type Description Notes data [User] Array of returned users. [optional] included [UserResponseIncludedItem] Array of objects related to the users. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"UsersResponse"},{"location":"v2/UsersResponse/#usersresponse","text":"Response containing information about multiple users.","title":"UsersResponse"},{"location":"v2/UsersResponse/#properties","text":"Name Type Description Notes data [User] Array of returned users. [optional] included [UserResponseIncludedItem] Array of objects related to the users. [optional] meta ResponseMetaAttributes [optional] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"},{"location":"v2/UsersType/","text":"UsersType Users resource type. Properties Name Type Description Notes value str Users resource type. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"UsersType"},{"location":"v2/UsersType/#userstype","text":"Users resource type.","title":"UsersType"},{"location":"v2/UsersType/#properties","text":"Name Type Description Notes value str Users resource type. defaults to \"users\", must be one of [\"users\", ] [Back to Model list] [Back to API list] [Back to README]","title":"Properties"}]} \ No newline at end of file diff --git a/v1/SyntheticsApi/index.html b/v1/SyntheticsApi/index.html index a692a258d2..748654750a 100644 --- a/v1/SyntheticsApi/index.html +++ b/v1/SyntheticsApi/index.html @@ -209,7 +209,7 @@ count=1, interval=3.14, ), - tick_every=SyntheticsTickInterval(60), + tick_every=SyntheticsTickInterval(30), ), public_id="public_id_example", status=SyntheticsTestPauseStatus("live"), @@ -313,7 +313,7 @@ count=1, interval=3.14, ), - tick_every=SyntheticsTickInterval(60), + tick_every=SyntheticsTickInterval(30), ), public_id="public_id_example", status=SyntheticsTestPauseStatus("live"), @@ -916,7 +916,7 @@ count=1, interval=3.14, ), - tick_every=SyntheticsTickInterval(60), + tick_every=SyntheticsTickInterval(30), ), public_id="public_id_example", status=SyntheticsTestPauseStatus("live"), @@ -1021,7 +1021,7 @@ count=1, interval=3.14, ), - tick_every=SyntheticsTickInterval(60), + tick_every=SyntheticsTickInterval(30), ), public_id="public_id_example", status=SyntheticsTestPauseStatus("live"), @@ -1109,4 +1109,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling SyntheticsApi->update_test_pause_status: %s\n" % e) -

Parameters

Name Type Description Notes
public_id str The public ID of the Synthetic test to update.
body SyntheticsUpdateTestPauseStatusPayload Status to set the given Synthetic test to.

Return type

bool

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK - Returns a boolean indicating if the update was successful. -
400 JSON format is wrong. -
403 Forbidden -
404 - Synthetic is not activated for the user - Test is not owned by the user -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: April 29, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
public_id str The public ID of the Synthetic test to update.
body SyntheticsUpdateTestPauseStatusPayload Status to set the given Synthetic test to.

Return type

bool

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK - Returns a boolean indicating if the update was successful. -
400 JSON format is wrong. -
403 Forbidden -
404 - Synthetic is not activated for the user - Test is not owned by the user -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: May 10, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestConfig/index.html b/v1/SyntheticsTestConfig/index.html index e24c24cf2b..261a982e58 100644 --- a/v1/SyntheticsTestConfig/index.html +++ b/v1/SyntheticsTestConfig/index.html @@ -1 +1 @@ - SyntheticsTestConfig - Datadog API Client for Python

SyntheticsTestConfig

Configuration object for a Synthetic test.

Properties

Name Type Description Notes
request SyntheticsTestRequest
assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to []
config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional]
variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file + SyntheticsTestConfig - Datadog API Client for Python

SyntheticsTestConfig

Configuration object for a Synthetic test.

Properties

Name Type Description Notes
assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to []
config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional]
request SyntheticsTestRequest [optional]
variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: May 10, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTickInterval/index.html b/v1/SyntheticsTickInterval/index.html index 07a3f10f15..f73d1e8d17 100644 --- a/v1/SyntheticsTickInterval/index.html +++ b/v1/SyntheticsTickInterval/index.html @@ -1 +1 @@ - SyntheticsTickInterval - Datadog API Client for Python

SyntheticsTickInterval

The frequency at which to run the Synthetic test (in seconds).

Properties

Name Type Description Notes
value int The frequency at which to run the Synthetic test (in seconds). must be one of [60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file + SyntheticsTickInterval - Datadog API Client for Python

SyntheticsTickInterval

The frequency at which to run the Synthetic test (in seconds).

Properties

Name Type Description Notes
value int The frequency at which to run the Synthetic test (in seconds). must be one of [30, 60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: May 10, 2021
\ No newline at end of file