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/
Python >= 3.6
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.v2Install 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.v2Please 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
# 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.v2.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.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("custom_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)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 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 | Get a list of logs |
| LogsApi | list_logs_get | GET /api/v2/logs/events | Get a quick 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 |
| 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 |
- 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
- LogsAggregateRequestPaging
- 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
- 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
- SecurityMonitoringRuleEvaluationWindow
- SecurityMonitoringRuleKeepAlive
- SecurityMonitoringRuleMaxSignalDuration
- SecurityMonitoringRuleOptions
- SecurityMonitoringRuleQuery
- SecurityMonitoringRuleQueryAggregation
- SecurityMonitoringRuleQueryCreate
- SecurityMonitoringRuleResponse
- SecurityMonitoringRuleSeverity
- SecurityMonitoringRuleUpdatePayload
- 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
- Type: API key
- API key parameter name: DD-API-KEY
- Location: HTTP header
- Type: API key
- API key parameter name: DD-APPLICATION-KEY
- Location: HTTP header
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 DefaultApifrom datadog_api_client.v2.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.v2
from datadog_api_client.v2.apis import *
from datadog_api_client.v2.models import *