Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

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
# 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')

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'

# Configure API key authorization: appKeyAuth
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'


# 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=["<KEY>:<VALUE>"],
        host_tags=["<KEY>:<VALUE>"],
        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 update_downtime PUT /api/v1/downtime/{downtime_id} Update a downtime
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 Get a list of logs
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 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
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 a SLO object
ServiceLevelObjectivesApi delete_slo DELETE /api/v1/slo/{slo_id} Delete a 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 a 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 Search SLOs
ServiceLevelObjectivesApi update_slo PUT /api/v1/slo/{slo_id} Update a SLO
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_test POST /api/v1/synthetics/tests Create a 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_latest_results GET /api/v1/synthetics/tests/{public_id}/results Get the test's latest results summaries (API)
SyntheticsApi get_api_test_result GET /api/v1/synthetics/tests/{public_id}/results/{result_id} Get a test result (API)
SyntheticsApi get_browser_test GET /api/v1/synthetics/tests/browser/{public_id} Get a test configuration (browser)
SyntheticsApi get_browser_test_latest_results GET /api/v1/synthetics/tests/browser/{public_id}/results Get the test's latest results summaries (browser)
SyntheticsApi get_browser_test_result GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} Get a test result (browser)
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 (API)
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 some Synthetics tests for CI
SyntheticsApi update_private_location PUT /api/v1/synthetics/private-locations/{location_id} Edit a private location
SyntheticsApi update_test PUT /api/v1/synthetics/tests/{public_id} Edit a test
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_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_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_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

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 1: 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 *