Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

datadog_api_client/v2

DatadogAPIClient::V2 - the Ruby gem for the Datadog API V2 Collection

Collection of all Datadog Public endpoints.

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'datadog_api_client/v2'

api_instance = DatadogAPIClient::V2::DashboardListsAPI.new
dashboard_list_id = 789 # Integer | ID of the dashboard list to add items to.
body = DatadogAPIClient::V2::DashboardListAddItemsRequest.new # DashboardListAddItemsRequest | Dashboards to add to the dashboard list.

begin
  #Add Items to a Dashboard List
  result = api_instance.create_dashboard_list_items(dashboard_list_id, body)
  p result
rescue DatadogAPIClient::V2::APIError => e
  puts "Exception when calling DashboardListsAPI->create_dashboard_list_items: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.datadoghq.com

Class Method HTTP request Description
DatadogAPIClient::V2::DashboardListsAPI create_dashboard_list_items POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Add Items to a Dashboard List
DatadogAPIClient::V2::DashboardListsAPI delete_dashboard_list_items DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Delete items from a dashboard list
DatadogAPIClient::V2::DashboardListsAPI get_dashboard_list_items GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Get items of a Dashboard List
DatadogAPIClient::V2::DashboardListsAPI update_dashboard_list_items PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards Update items of a dashboard list
DatadogAPIClient::V2::IncidentServicesAPI create_incident_service POST /api/v2/services Create a new incident service
DatadogAPIClient::V2::IncidentServicesAPI delete_incident_service DELETE /api/v2/services/{service_id} Delete an existing incident service
DatadogAPIClient::V2::IncidentServicesAPI get_incident_service GET /api/v2/services/{service_id} Get details of an incident service
DatadogAPIClient::V2::IncidentServicesAPI list_incident_services GET /api/v2/services Get a list of all incident services
DatadogAPIClient::V2::IncidentServicesAPI update_incident_service PATCH /api/v2/services/{service_id} Update an existing incident service
DatadogAPIClient::V2::IncidentTeamsAPI create_incident_team POST /api/v2/teams Create a new incident team
DatadogAPIClient::V2::IncidentTeamsAPI delete_incident_team DELETE /api/v2/teams/{team_id} Delete an existing incident team
DatadogAPIClient::V2::IncidentTeamsAPI get_incident_team GET /api/v2/teams/{team_id} Get details of an incident team
DatadogAPIClient::V2::IncidentTeamsAPI list_incident_teams GET /api/v2/teams Get a list of all incident teams
DatadogAPIClient::V2::IncidentTeamsAPI update_incident_team PATCH /api/v2/teams/{team_id} Update an existing incident team
DatadogAPIClient::V2::IncidentsAPI create_incident POST /api/v2/incidents Create an incident
DatadogAPIClient::V2::IncidentsAPI delete_incident DELETE /api/v2/incidents/{incident_id} Delete an existing incident
DatadogAPIClient::V2::IncidentsAPI get_incident GET /api/v2/incidents/{incident_id} Get the details of an incident
DatadogAPIClient::V2::IncidentsAPI list_incidents GET /api/v2/incidents Get a list of incidents
DatadogAPIClient::V2::IncidentsAPI update_incident PATCH /api/v2/incidents/{incident_id} Update an existing incident
DatadogAPIClient::V2::KeyManagementAPI create_api_key POST /api/v2/api_keys Create an API key
DatadogAPIClient::V2::KeyManagementAPI create_current_user_application_key POST /api/v2/current_user/application_keys Create an application key for current user
DatadogAPIClient::V2::KeyManagementAPI delete_api_key DELETE /api/v2/api_keys/{api_key_id} Delete an API key
DatadogAPIClient::V2::KeyManagementAPI delete_application_key DELETE /api/v2/application_keys/{app_key_id} Delete an application key
DatadogAPIClient::V2::KeyManagementAPI delete_current_user_application_key DELETE /api/v2/current_user/application_keys/{app_key_id} Delete an application key owned by current user
DatadogAPIClient::V2::KeyManagementAPI get_api_key GET /api/v2/api_keys/{api_key_id} Get API key
DatadogAPIClient::V2::KeyManagementAPI get_application_key GET /api/v2/application_keys/{app_key_id} Get an application key
DatadogAPIClient::V2::KeyManagementAPI get_current_user_application_key GET /api/v2/current_user/application_keys/{app_key_id} Get one application key owned by current user
DatadogAPIClient::V2::KeyManagementAPI list_api_keys GET /api/v2/api_keys Get all API keys
DatadogAPIClient::V2::KeyManagementAPI list_application_keys GET /api/v2/application_keys Get all application keys
DatadogAPIClient::V2::KeyManagementAPI list_current_user_application_keys GET /api/v2/current_user/application_keys Get all application keys owned by current user
DatadogAPIClient::V2::KeyManagementAPI update_api_key PATCH /api/v2/api_keys/{api_key_id} Edit an API key
DatadogAPIClient::V2::KeyManagementAPI update_application_key PATCH /api/v2/application_keys/{app_key_id} Edit an application key
DatadogAPIClient::V2::KeyManagementAPI update_current_user_application_key PATCH /api/v2/current_user/application_keys/{app_key_id} Edit an application key owned by current user
DatadogAPIClient::V2::LogsAPI aggregate_logs POST /api/v2/logs/analytics/aggregate Aggregate events
DatadogAPIClient::V2::LogsAPI list_logs POST /api/v2/logs/events/search Search logs
DatadogAPIClient::V2::LogsAPI list_logs_get GET /api/v2/logs/events Get a list of logs
DatadogAPIClient::V2::LogsArchivesAPI add_read_role_to_archive POST /api/v2/logs/config/archives/{archive_id}/readers Grant role to an archive
DatadogAPIClient::V2::LogsArchivesAPI create_logs_archive POST /api/v2/logs/config/archives Create an archive
DatadogAPIClient::V2::LogsArchivesAPI delete_logs_archive DELETE /api/v2/logs/config/archives/{archive_id} Delete an archive
DatadogAPIClient::V2::LogsArchivesAPI get_logs_archive GET /api/v2/logs/config/archives/{archive_id} Get an archive
DatadogAPIClient::V2::LogsArchivesAPI get_logs_archive_order GET /api/v2/logs/config/archive-order Get archive order
DatadogAPIClient::V2::LogsArchivesAPI list_archive_read_roles GET /api/v2/logs/config/archives/{archive_id}/readers List read roles for an archive
DatadogAPIClient::V2::LogsArchivesAPI list_logs_archives GET /api/v2/logs/config/archives Get all archives
DatadogAPIClient::V2::LogsArchivesAPI remove_role_from_archive DELETE /api/v2/logs/config/archives/{archive_id}/readers Revoke role from an archive
DatadogAPIClient::V2::LogsArchivesAPI update_logs_archive PUT /api/v2/logs/config/archives/{archive_id} Update an archive
DatadogAPIClient::V2::LogsArchivesAPI update_logs_archive_order PUT /api/v2/logs/config/archive-order Update archive order
DatadogAPIClient::V2::LogsMetricsAPI create_logs_metric POST /api/v2/logs/config/metrics Create a log-based metric
DatadogAPIClient::V2::LogsMetricsAPI delete_logs_metric DELETE /api/v2/logs/config/metrics/{metric_id} Delete a log-based metric
DatadogAPIClient::V2::LogsMetricsAPI get_logs_metric GET /api/v2/logs/config/metrics/{metric_id} Get a log-based metric
DatadogAPIClient::V2::LogsMetricsAPI list_logs_metrics GET /api/v2/logs/config/metrics Get all log-based metrics
DatadogAPIClient::V2::LogsMetricsAPI update_logs_metric PATCH /api/v2/logs/config/metrics/{metric_id} Update a log-based metric
DatadogAPIClient::V2::MetricsAPI create_tag_configuration POST /api/v2/metrics/{metric_name}/tags Create a tag configuration
DatadogAPIClient::V2::MetricsAPI delete_tag_configuration DELETE /api/v2/metrics/{metric_name}/tags Delete a tag configuration
DatadogAPIClient::V2::MetricsAPI list_tag_configuration_by_name GET /api/v2/metrics/{metric_name}/tags List tag configuration by name
DatadogAPIClient::V2::MetricsAPI list_tag_configurations GET /api/v2/metrics List tag configurations
DatadogAPIClient::V2::MetricsAPI list_tags_by_metric_name GET /api/v2/metrics/{metric_name}/all-tags List tags by metric name
DatadogAPIClient::V2::MetricsAPI list_volumes_by_metric_name GET /api/v2/metrics/{metric_name}/volumes List distinct metric volumes by metric name
DatadogAPIClient::V2::MetricsAPI update_tag_configuration PATCH /api/v2/metrics/{metric_name}/tags Update a tag configuration
DatadogAPIClient::V2::ProcessesAPI list_processes GET /api/v2/processes Get all processes
DatadogAPIClient::V2::RolesAPI add_permission_to_role POST /api/v2/roles/{role_id}/permissions Grant permission to a role
DatadogAPIClient::V2::RolesAPI add_user_to_role POST /api/v2/roles/{role_id}/users Add a user to a role
DatadogAPIClient::V2::RolesAPI create_role POST /api/v2/roles Create role
DatadogAPIClient::V2::RolesAPI delete_role DELETE /api/v2/roles/{role_id} Delete role
DatadogAPIClient::V2::RolesAPI get_role GET /api/v2/roles/{role_id} Get a role
DatadogAPIClient::V2::RolesAPI list_permissions GET /api/v2/permissions List permissions
DatadogAPIClient::V2::RolesAPI list_role_permissions GET /api/v2/roles/{role_id}/permissions List permissions for a role
DatadogAPIClient::V2::RolesAPI list_role_users GET /api/v2/roles/{role_id}/users Get all users of a role
DatadogAPIClient::V2::RolesAPI list_roles GET /api/v2/roles List roles
DatadogAPIClient::V2::RolesAPI remove_permission_from_role DELETE /api/v2/roles/{role_id}/permissions Revoke permission
DatadogAPIClient::V2::RolesAPI remove_user_from_role DELETE /api/v2/roles/{role_id}/users Remove a user from a role
DatadogAPIClient::V2::RolesAPI update_role PATCH /api/v2/roles/{role_id} Update a role
DatadogAPIClient::V2::SecurityMonitoringAPI create_security_filter POST /api/v2/security_monitoring/configuration/security_filters Create a security filter
DatadogAPIClient::V2::SecurityMonitoringAPI create_security_monitoring_rule POST /api/v2/security_monitoring/rules Create a detection rule
DatadogAPIClient::V2::SecurityMonitoringAPI delete_security_filter DELETE /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} Delete a security filter
DatadogAPIClient::V2::SecurityMonitoringAPI delete_security_monitoring_rule DELETE /api/v2/security_monitoring/rules/{rule_id} Delete an existing rule
DatadogAPIClient::V2::SecurityMonitoringAPI get_security_filter GET /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} Get a security filter
DatadogAPIClient::V2::SecurityMonitoringAPI get_security_monitoring_rule GET /api/v2/security_monitoring/rules/{rule_id} Get a rule's details
DatadogAPIClient::V2::SecurityMonitoringAPI list_security_filters GET /api/v2/security_monitoring/configuration/security_filters Get all security filters
DatadogAPIClient::V2::SecurityMonitoringAPI list_security_monitoring_rules GET /api/v2/security_monitoring/rules List rules
DatadogAPIClient::V2::SecurityMonitoringAPI list_security_monitoring_signals GET /api/v2/security_monitoring/signals Get a quick list of security signals
DatadogAPIClient::V2::SecurityMonitoringAPI search_security_monitoring_signals POST /api/v2/security_monitoring/signals/search Get a list of security signals
DatadogAPIClient::V2::SecurityMonitoringAPI update_security_filter PATCH /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} Update a security filter
DatadogAPIClient::V2::SecurityMonitoringAPI update_security_monitoring_rule PUT /api/v2/security_monitoring/rules/{rule_id} Update an existing rule
DatadogAPIClient::V2::ServiceAccountsAPI create_service_account_application_key POST /api/v2/service_accounts/{service_account_id}/application_keys Create an application key for this service account
DatadogAPIClient::V2::ServiceAccountsAPI delete_service_account_application_key DELETE /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} Delete an application key for this service account
DatadogAPIClient::V2::ServiceAccountsAPI get_service_account_application_key GET /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} Get one application key for this service account
DatadogAPIClient::V2::ServiceAccountsAPI list_service_account_application_keys GET /api/v2/service_accounts/{service_account_id}/application_keys List application keys for this service account
DatadogAPIClient::V2::ServiceAccountsAPI update_service_account_application_key PATCH /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} Edit an application key for this service account
DatadogAPIClient::V2::UsersAPI create_service_account POST /api/v2/service_accounts Create a service account
DatadogAPIClient::V2::UsersAPI create_user POST /api/v2/users Create a user
DatadogAPIClient::V2::UsersAPI disable_user DELETE /api/v2/users/{user_id} Disable a user
DatadogAPIClient::V2::UsersAPI get_invitation GET /api/v2/user_invitations/{user_invitation_uuid} Get a user invitation
DatadogAPIClient::V2::UsersAPI get_user GET /api/v2/users/{user_id} Get user details
DatadogAPIClient::V2::UsersAPI list_user_organizations GET /api/v2/users/{user_id}/orgs Get a user organization
DatadogAPIClient::V2::UsersAPI list_user_permissions GET /api/v2/users/{user_id}/permissions Get a user permissions
DatadogAPIClient::V2::UsersAPI list_users GET /api/v2/users List all users
DatadogAPIClient::V2::UsersAPI send_invitations POST /api/v2/user_invitations Send invitation emails
DatadogAPIClient::V2::UsersAPI update_user PATCH /api/v2/users/{user_id} Update a user

Documentation for Models

Documentation for Authorization

AuthZ

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /oauth2/v1/authorize
  • Scopes:
    • dashboards_public_share: The ability to share dashboards externally.
    • dashboards_read: The ability to view dashboards.
    • dashboards_write: The ability to create and change dashboards.
    • events_read: The ability to read events data.
    • incident_read: The ability to view incidents in Datadog.
    • incident_settings_write: The ability to configure incident settings.
    • incident_write: The ability to create, view, and manage incidents in Datadog.
    • metrics_read: The ability to view custom metrics.
    • security_monitoring_filters_read: The ability to read Security Filters.
    • security_monitoring_filters_write: The ability to create, edit and delete Security Filters.
    • security_monitoring_rules_read: The ability to read Detection rules.
    • security_monitoring_rules_write: The ability to create and edit Detection rules.
    • security_monitoring_signals_read: The ability to view Security signals.
    • user_access_invite: Allows users to invite other users to your organization.
    • user_access_manage: Grants the permission to disable users, manage user roles and SAML-to-role mappings.

apiKeyAuth

  • Type: API key
  • API key parameter name: DD-API-KEY
  • Location: HTTP header

appKeyAuth

  • Type: API key
  • API key parameter name: DD-APPLICATION-KEY
  • Location: HTTP header