Class: DatadogAPIClient::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/datadog_api_client/configuration.rb', line 162

def initialize
  @scheme = 'https'
  @host = 'api.datadoghq.com'
  @base_path = ''
  @server_index = 0
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @enable_retry = false
  @backoff_base = 2
  @backoff_multiplier = 2
  @max_retries = 3
  @timeout = nil
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @cert_file = nil
  @key_file = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @compress = true
  @http_proxyaddr = nil
  @http_proxyport = nil
  @http_proxyuser = nil
  @http_proxypass = nil
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
  @unstable_operations = {
        "v2.cancel_fleet_deployment": false,
        "v2.create_fleet_deployment_configure": false,
        "v2.create_fleet_deployment_upgrade": false,
        "v2.create_fleet_schedule": false,
        "v2.delete_fleet_schedule": false,
        "v2.get_fleet_agent_info": false,
        "v2.get_fleet_deployment": false,
        "v2.get_fleet_schedule": false,
        "v2.list_fleet_agents": false,
        "v2.list_fleet_agent_tracers": false,
        "v2.list_fleet_agent_versions": false,
        "v2.list_fleet_clusters": false,
        "v2.list_fleet_deployments": false,
        "v2.list_fleet_instrumented_pods": false,
        "v2.list_fleet_schedules": false,
        "v2.list_fleet_tracers": false,
        "v2.trigger_fleet_schedule": false,
        "v2.update_fleet_schedule": false,
        "v2.create_llm_obs_annotation_queue": false,
        "v2.create_llm_obs_annotation_queue_interactions": false,
        "v2.create_llm_obs_dataset": false,
        "v2.create_llm_obs_dataset_records": false,
        "v2.create_llm_obs_experiment": false,
        "v2.create_llm_obs_experiment_events": false,
        "v2.create_llm_obs_project": false,
        "v2.delete_llm_obs_annotation_queue": false,
        "v2.delete_llm_obs_annotation_queue_interactions": false,
        "v2.delete_llm_obs_custom_eval_config": false,
        "v2.delete_llm_obs_dataset_records": false,
        "v2.delete_llm_obs_datasets": false,
        "v2.delete_llm_obs_experiments": false,
        "v2.delete_llm_obs_projects": false,
        "v2.get_llm_obs_annotated_interactions": false,
        "v2.get_llm_obs_custom_eval_config": false,
        "v2.list_llm_obs_annotation_queues": false,
        "v2.list_llm_obs_dataset_records": false,
        "v2.list_llm_obs_datasets": false,
        "v2.list_llm_obs_experiments": false,
        "v2.list_llm_obs_projects": false,
        "v2.update_llm_obs_annotation_queue": false,
        "v2.update_llm_obs_custom_eval_config": false,
        "v2.update_llm_obs_dataset": false,
        "v2.update_llm_obs_dataset_records": false,
        "v2.update_llm_obs_experiment": false,
        "v2.update_llm_obs_project": false,
        "v2.anonymize_users": false,
        "v2.create_open_api": false,
        "v2.delete_open_api": false,
        "v2.get_open_api": false,
        "v2.list_apis": false,
        "v2.update_open_api": false,
        "v2.get_investigation": false,
        "v2.list_investigations": false,
        "v2.trigger_investigation": false,
        "v2.create_case_jira_issue": false,
        "v2.create_case_notebook": false,
        "v2.create_case_service_now_ticket": false,
        "v2.link_incident": false,
        "v2.link_jira_issue_to_case": false,
        "v2.move_case_to_project": false,
        "v2.unlink_jira_issue": false,
        "v2.create_change_request": false,
        "v2.create_change_request_branch": false,
        "v2.delete_change_request_decision": false,
        "v2.get_change_request": false,
        "v2.update_change_request": false,
        "v2.update_change_request_decision": false,
        "v2.delete_test_optimization_service_settings": false,
        "v2.get_flaky_tests_management_policies": false,
        "v2.get_test_optimization_service_settings": false,
        "v2.search_flaky_tests": false,
        "v2.update_flaky_tests": false,
        "v2.update_flaky_tests_management_policies": false,
        "v2.update_test_optimization_service_settings": false,
        "v2.create_aws_cloud_auth_persona_mapping": false,
        "v2.delete_aws_cloud_auth_persona_mapping": false,
        "v2.get_aws_cloud_auth_persona_mapping": false,
        "v2.list_aws_cloud_auth_persona_mappings": false,
        "v2.activate_content_pack": false,
        "v2.bulk_export_security_monitoring_terraform_resources": false,
        "v2.cancel_historical_job": false,
        "v2.convert_job_result_to_signal": false,
        "v2.convert_security_monitoring_terraform_resource": false,
        "v2.deactivate_content_pack": false,
        "v2.delete_historical_job": false,
        "v2.export_security_monitoring_terraform_resource": false,
        "v2.get_content_packs_states": false,
        "v2.get_finding": false,
        "v2.get_historical_job": false,
        "v2.get_indicator_of_compromise": false,
        "v2.get_rule_version_history": false,
        "v2.get_secrets_rules": false,
        "v2.get_security_monitoring_histsignal": false,
        "v2.get_security_monitoring_histsignals_by_job_id": false,
        "v2.list_findings": false,
        "v2.list_historical_jobs": false,
        "v2.list_indicators_of_compromise": false,
        "v2.list_multiple_rulesets": false,
        "v2.list_scanned_assets_metadata": false,
        "v2.list_security_monitoring_histsignals": false,
        "v2.list_vulnerabilities": false,
        "v2.list_vulnerable_assets": false,
        "v2.mute_findings": false,
        "v2.run_historical_job": false,
        "v2.search_security_monitoring_histsignals": false,
        "v2.get_code_coverage_branch_summary": false,
        "v2.get_code_coverage_commit_summary": false,
        "v2.create_dashboard_secure_embed": false,
        "v2.delete_dashboard_secure_embed": false,
        "v2.get_dashboard_secure_embed": false,
        "v2.update_dashboard_secure_embed": false,
        "v2.create_dataset": false,
        "v2.delete_dataset": false,
        "v2.get_all_datasets": false,
        "v2.get_dataset": false,
        "v2.update_dataset": false,
        "v2.cancel_data_deletion_request": false,
        "v2.create_data_deletion_request": false,
        "v2.get_data_deletion_requests": false,
        "v2.create_deployment_gate": false,
        "v2.create_deployment_rule": false,
        "v2.delete_deployment_gate": false,
        "v2.delete_deployment_rule": false,
        "v2.get_deployment_gate": false,
        "v2.get_deployment_gate_rules": false,
        "v2.get_deployment_gates_evaluation_result": false,
        "v2.get_deployment_rule": false,
        "v2.list_deployment_gates": false,
        "v2.trigger_deployment_gates_evaluation": false,
        "v2.update_deployment_gate": false,
        "v2.update_deployment_rule": false,
        "v2.create_hamr_org_connection": false,
        "v2.get_hamr_org_connection": false,
        "v2.create_global_incident_handle": false,
        "v2.create_incident": false,
        "v2.create_incident_attachment": false,
        "v2.create_incident_integration": false,
        "v2.create_incident_notification_rule": false,
        "v2.create_incident_notification_template": false,
        "v2.create_incident_postmortem_attachment": false,
        "v2.create_incident_postmortem_template": false,
        "v2.create_incident_todo": false,
        "v2.create_incident_type": false,
        "v2.create_incident_user_defined_field": false,
        "v2.delete_global_incident_handle": false,
        "v2.delete_incident": false,
        "v2.delete_incident_attachment": false,
        "v2.delete_incident_integration": false,
        "v2.delete_incident_notification_rule": false,
        "v2.delete_incident_notification_template": false,
        "v2.delete_incident_postmortem_template": false,
        "v2.delete_incident_todo": false,
        "v2.delete_incident_type": false,
        "v2.delete_incident_user_defined_field": false,
        "v2.get_global_incident_settings": false,
        "v2.get_incident": false,
        "v2.get_incident_integration": false,
        "v2.get_incident_notification_rule": false,
        "v2.get_incident_notification_template": false,
        "v2.get_incident_postmortem_template": false,
        "v2.get_incident_todo": false,
        "v2.get_incident_type": false,
        "v2.get_incident_user_defined_field": false,
        "v2.import_incident": false,
        "v2.list_global_incident_handles": false,
        "v2.list_incident_attachments": false,
        "v2.list_incident_integrations": false,
        "v2.list_incident_notification_rules": false,
        "v2.list_incident_notification_templates": false,
        "v2.list_incident_postmortem_templates": false,
        "v2.list_incidents": false,
        "v2.list_incident_todos": false,
        "v2.list_incident_types": false,
        "v2.list_incident_user_defined_fields": false,
        "v2.search_incidents": false,
        "v2.update_global_incident_handle": false,
        "v2.update_global_incident_settings": false,
        "v2.update_incident": false,
        "v2.update_incident_attachment": false,
        "v2.update_incident_integration": false,
        "v2.update_incident_notification_rule": false,
        "v2.update_incident_notification_template": false,
        "v2.update_incident_postmortem_template": false,
        "v2.update_incident_todo": false,
        "v2.update_incident_type": false,
        "v2.update_incident_user_defined_field": false,
        "v2.create_aws_account_ccm_config": false,
        "v2.delete_aws_account_ccm_config": false,
        "v2.get_aws_account_ccm_config": false,
        "v2.update_aws_account_ccm_config": false,
        "v2.create_jira_issue_template": false,
        "v2.delete_jira_account": false,
        "v2.delete_jira_issue_template": false,
        "v2.get_jira_issue_template": false,
        "v2.list_jira_accounts": false,
        "v2.list_jira_issue_templates": false,
        "v2.update_jira_issue_template": false,
        "v2.create_tenancy_config": false,
        "v2.get_tenancy_configs": false,
        "v2.add_role_to_restriction_query": false,
        "v2.create_restriction_query": false,
        "v2.delete_restriction_query": false,
        "v2.get_restriction_query": false,
        "v2.get_role_restriction_query": false,
        "v2.list_restriction_queries": false,
        "v2.list_restriction_query_roles": false,
        "v2.list_user_restriction_queries": false,
        "v2.remove_role_from_restriction_query": false,
        "v2.replace_restriction_query": false,
        "v2.update_restriction_query": false,
        "v2.create_monitor_user_template": false,
        "v2.delete_monitor_user_template": false,
        "v2.get_monitor_user_template": false,
        "v2.list_monitor_user_templates": false,
        "v2.update_monitor_user_template": false,
        "v2.validate_existing_monitor_user_template": false,
        "v2.validate_monitor_user_template": false,
        "v2.bulk_update_org_group_memberships": false,
        "v2.create_org_group": false,
        "v2.create_org_group_policy": false,
        "v2.create_org_group_policy_override": false,
        "v2.delete_org_group": false,
        "v2.delete_org_group_policy": false,
        "v2.delete_org_group_policy_override": false,
        "v2.get_org_group": false,
        "v2.get_org_group_membership": false,
        "v2.get_org_group_policy": false,
        "v2.get_org_group_policy_override": false,
        "v2.list_org_group_memberships": false,
        "v2.list_org_group_policies": false,
        "v2.list_org_group_policy_configs": false,
        "v2.list_org_group_policy_overrides": false,
        "v2.list_org_groups": false,
        "v2.update_org_group": false,
        "v2.update_org_group_membership": false,
        "v2.update_org_group_policy": false,
        "v2.update_org_group_policy_override": false,
        "v2.list_role_templates": false,
        "v2.create_connection": false,
        "v2.delete_connection": false,
        "v2.get_account_facet_info": false,
        "v2.get_mapping": false,
        "v2.get_user_facet_info": false,
        "v2.list_connections": false,
        "v2.query_accounts": false,
        "v2.query_event_filtered_users": false,
        "v2.query_users": false,
        "v2.update_connection": false,
        "v2.create_scorecard_outcomes_batch": false,
        "v2.list_entity_risk_scores": false,
        "v2.create_incident_service": false,
        "v2.delete_incident_service": false,
        "v2.get_incident_service": false,
        "v2.list_incident_services": false,
        "v2.update_incident_service": false,
        "v2.create_slo_report_job": false,
        "v2.get_slo_report": false,
        "v2.get_slo_report_job_status": false,
        "v2.get_slo_status": false,
        "v2.get_spa_recommendations": false,
        "v2.get_spa_recommendations_with_shard": false,
        "v2.create_custom_rule": false,
        "v2.create_custom_rule_revision": false,
        "v2.create_sca_resolve_vulnerable_symbols": false,
        "v2.create_sca_result": false,
        "v2.delete_custom_rule": false,
        "v2.delete_custom_ruleset": false,
        "v2.get_custom_rule": false,
        "v2.get_custom_rule_revision": false,
        "v2.get_custom_ruleset": false,
        "v2.list_custom_rule_revisions": false,
        "v2.revert_custom_rule_revision": false,
        "v2.update_custom_ruleset": false,
        "v2.add_member_team": false,
        "v2.list_member_teams": false,
        "v2.remove_member_team": false,
        "v2.create_incident_team": false,
        "v2.delete_incident_team": false,
        "v2.get_incident_team": false,
        "v2.list_incident_teams": false,
        "v2.update_incident_team": false,
  }
  @server_variables[:site] = ENV['DD_SITE'] if ENV.key? 'DD_SITE'
  @api_key['apiKeyAuth'] = ENV['DD_API_KEY'] if ENV.key? 'DD_API_KEY'
  @api_key['appKeyAuth'] = ENV['DD_APP_KEY'] if ENV.key? 'DD_APP_KEY'

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



66
67
68
 
# File 'lib/datadog_api_client/configuration.rb', line 66

def access_token
  @access_token
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



45
46
47
 
# File 'lib/datadog_api_client/configuration.rb', line 45

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



53
54
55
 
# File 'lib/datadog_api_client/configuration.rb', line 53

def api_key_prefix
  @api_key_prefix
end

#backoff_base ⇒ Object

Retry backoff calculation parameters



156
157
158
 
# File 'lib/datadog_api_client/configuration.rb', line 156

def backoff_base
  @backoff_base
end

#backoff_multiplier ⇒ Object

Returns the value of attribute backoff_multiplier.



157
158
159
 
# File 'lib/datadog_api_client/configuration.rb', line 157

def backoff_multiplier
  @backoff_multiplier
end

#base_path ⇒ Object

Defines url base path



25
26
27
 
# File 'lib/datadog_api_client/configuration.rb', line 25

def base_path
  @base_path
end

#cert_file ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



126
127
128
 
# File 'lib/datadog_api_client/configuration.rb', line 126

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


95
96
97
 
# File 'lib/datadog_api_client/configuration.rb', line 95

def client_side_validation
  @client_side_validation
end

#compress ⇒ Object

Set this to add accept encoding header for compression



137
138
139
 
# File 'lib/datadog_api_client/configuration.rb', line 137

def compress
  @compress
end

#debugging ⇒ true, false

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with ‘logger.debug` (see the `logger` attribute). Default to false.

Returns:

  • (true, false) 


73
74
75
 
# File 'lib/datadog_api_client/configuration.rb', line 73

def debugging
  @debugging
end

#enable_retry ⇒ Object

Enable retry when rate limited



153
154
155
 
# File 'lib/datadog_api_client/configuration.rb', line 153

def enable_retry
  @enable_retry
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



134
135
136
 
# File 'lib/datadog_api_client/configuration.rb', line 134

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



22
23
24
 
# File 'lib/datadog_api_client/configuration.rb', line 22

def host
  @host
end

#http_proxyaddr ⇒ Object

Proxy settings Address of proxy server to use



141
142
143
 
# File 'lib/datadog_api_client/configuration.rb', line 141

def http_proxyaddr
  @http_proxyaddr
end

#http_proxypass ⇒ Object

Password for proxy server authentication



150
151
152
 
# File 'lib/datadog_api_client/configuration.rb', line 150

def http_proxypass
  @http_proxypass
end

#http_proxyport ⇒ Object

Port of proxy server to use



144
145
146
 
# File 'lib/datadog_api_client/configuration.rb', line 144

def http_proxyport
  @http_proxyport
end

#http_proxyuser ⇒ Object

User for proxy server authentication



147
148
149
 
# File 'lib/datadog_api_client/configuration.rb', line 147

def http_proxyuser
  @http_proxyuser
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



132
133
134
 
# File 'lib/datadog_api_client/configuration.rb', line 132

def inject_format
  @inject_format
end

#key_file ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



130
131
132
 
# File 'lib/datadog_api_client/configuration.rb', line 130

def key_file
  @key_file
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


79
80
81
 
# File 'lib/datadog_api_client/configuration.rb', line 79

def logger
  @logger
end

#max_retries ⇒ Object

Maximum number of retry attempts allowed



160
161
162
 
# File 'lib/datadog_api_client/configuration.rb', line 160

def max_retries
  @max_retries
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


63
64
65
 
# File 'lib/datadog_api_client/configuration.rb', line 63

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



19
20
21
 
# File 'lib/datadog_api_client/configuration.rb', line 19

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



28
29
30
 
# File 'lib/datadog_api_client/configuration.rb', line 28

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



31
32
33
 
# File 'lib/datadog_api_client/configuration.rb', line 31

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



37
38
39
 
# File 'lib/datadog_api_client/configuration.rb', line 37

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



34
35
36
 
# File 'lib/datadog_api_client/configuration.rb', line 34

def server_variables
  @server_variables
end

#ssl_ca_cert ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

Returns:

  • (String) —

    the path to the certificate file



122
123
124
 
# File 'lib/datadog_api_client/configuration.rb', line 122

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:

  • (String) 


86
87
88
 
# File 'lib/datadog_api_client/configuration.rb', line 86

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



90
91
92
 
# File 'lib/datadog_api_client/configuration.rb', line 90

def timeout
  @timeout
end

#unstable_operations ⇒ Object

Keep track of the unstable operations, and if they have been enabled



98
99
100
 
# File 'lib/datadog_api_client/configuration.rb', line 98

def unstable_operations
  @unstable_operations
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


58
59
60
 
# File 'lib/datadog_api_client/configuration.rb', line 58

def username
  @username
end

#verify_ssl ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:

  • (true, false) 


107
108
109
 
# File 'lib/datadog_api_client/configuration.rb', line 107

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.

Returns:

  • (true, false) 


116
117
118
 
# File 'lib/datadog_api_client/configuration.rb', line 116

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



482
483
484
 
# File 'lib/datadog_api_client/configuration.rb', line 482

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



523
524
525
526
527
528
529
530
531
 
# File 'lib/datadog_api_client/configuration.rb', line 523

def api_key_with_prefix(param_name, param_alias = nil)
  key = @api_key[param_name]
  key = @api_key.fetch(param_alias, key) unless param_alias.nil?
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{key}"
  else
    key
  end
end

#application_key=(app_key) ⇒ Object

Sets application key.



539
540
541
 
# File 'lib/datadog_api_client/configuration.rb', line 539

def application_key=(app_key)
  @api_key['appKeyAuth'] = app_key
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/datadog_api_client/configuration.rb', line 549

def auth_settings
  {
    AuthZ:
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
    apiKeyAuth:
      {
        type: 'api_key',
        in: 'header',
        key: 'DD-API-KEY',
        value: api_key_with_prefix('apiKeyAuth')
      },
    appKeyAuth:
      {
        type: 'api_key',
        in: 'header',
        key: 'DD-APPLICATION-KEY',
        value: api_key_with_prefix('appKeyAuth')
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



514
515
516
517
518
519
 
# File 'lib/datadog_api_client/configuration.rb', line 514

def base_url(operation = nil)
  index = server_operation_index.fetch(operation.to_sym, server_index)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

  server_url(index, server_operation_variables.fetch(operation.to_sym, server_variables), operation_server_settings[operation.to_sym])
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



544
545
546
 
# File 'lib/datadog_api_client/configuration.rb', line 544

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



493
494
495
 
# File 'lib/datadog_api_client/configuration.rb', line 493

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/datadog_api_client/configuration.rb', line 633

def operation_server_settings
  {
    "v1.get_ip_ranges": [
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The regional site for Datadog customers.",
            default_value: "datadoghq.com",
            enum_values: [
              "datadoghq.com",
              "us3.datadoghq.com",
              "us5.datadoghq.com",
              "ap1.datadoghq.com",
              "ap2.datadoghq.com",
              "datadoghq.eu",
              "ddog-gov.com",
              "us2.ddog-gov.com"
            ]
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "ip-ranges",
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "ip-ranges.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.datadoghq.com",
        description: "No description provided",
        variables: {
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "ip-ranges",
          }
        }
      }
    ],
    "v1.submit_log": [
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The regional site for Datadog customers.",
            default_value: "datadoghq.com",
            enum_values: [
              "datadoghq.com",
              "us3.datadoghq.com",
              "us5.datadoghq.com",
              "ap1.datadoghq.com",
              "ap2.datadoghq.com",
              "datadoghq.eu",
              "ddog-gov.com",
              "us2.ddog-gov.com"
            ]
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "http-intake.logs.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      }
    ],
    "v2.create_event": [
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The regional site for customers.",
            default_value: "datadoghq.com",
            enum_values: [
              "datadoghq.com",
              "us3.datadoghq.com",
              "us5.datadoghq.com",
              "ap1.datadoghq.com",
              "ap2.datadoghq.com",
              "datadoghq.eu",
              "ddog-gov.com",
              "us2.ddog-gov.com"
            ]
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "event-management-intake",
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "event-management-intake.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "event-management-intake",
          }
        }
      }
    ],
    "v2.submit_log": [
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The regional site for customers.",
            default_value: "datadoghq.com",
            enum_values: [
              "datadoghq.com",
              "us3.datadoghq.com",
              "us5.datadoghq.com",
              "ap1.datadoghq.com",
              "ap2.datadoghq.com",
              "datadoghq.eu",
              "ddog-gov.com",
              "us2.ddog-gov.com"
            ]
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "http-intake.logs.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      }
    ],
    "v2.create_on_call_page": [
      {
        url: +"https://{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The globally available endpoint for On-Call.",
            default_value: "navy.oncall.datadoghq.com",
            enum_values: [
              "lava.oncall.datadoghq.com",
              "saffron.oncall.datadoghq.com",
              "navy.oncall.datadoghq.com",
              "coral.oncall.datadoghq.com",
              "teal.oncall.datadoghq.com",
              "beige.oncall.datadoghq.eu"
            ]
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "api.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "api",
          }
        }
      }
    ],
    "v2.acknowledge_on_call_page": [
      {
        url: +"https://{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The globally available endpoint for On-Call.",
            default_value: "navy.oncall.datadoghq.com",
            enum_values: [
              "lava.oncall.datadoghq.com",
              "saffron.oncall.datadoghq.com",
              "navy.oncall.datadoghq.com",
              "coral.oncall.datadoghq.com",
              "teal.oncall.datadoghq.com",
              "beige.oncall.datadoghq.eu"
            ]
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "api.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "api",
          }
        }
      }
    ],
    "v2.escalate_on_call_page": [
      {
        url: +"https://{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The globally available endpoint for On-Call.",
            default_value: "navy.oncall.datadoghq.com",
            enum_values: [
              "lava.oncall.datadoghq.com",
              "saffron.oncall.datadoghq.com",
              "navy.oncall.datadoghq.com",
              "coral.oncall.datadoghq.com",
              "teal.oncall.datadoghq.com",
              "beige.oncall.datadoghq.eu"
            ]
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "api.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "api",
          }
        }
      }
    ],
    "v2.resolve_on_call_page": [
      {
        url: +"https://{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The globally available endpoint for On-Call.",
            default_value: "navy.oncall.datadoghq.com",
            enum_values: [
              "lava.oncall.datadoghq.com",
              "saffron.oncall.datadoghq.com",
              "navy.oncall.datadoghq.com",
              "coral.oncall.datadoghq.com",
              "teal.oncall.datadoghq.com",
              "beige.oncall.datadoghq.eu"
            ]
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "api.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "api",
          }
        }
      }
    ],
    "v2.submit_product_analytics_event": [
      {
        url: +"https://{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The intake domain for the regional site.",
            default_value: "browser-intake-datadoghq.com",
            enum_values: [
              "browser-intake-datadoghq.com",
              "browser-intake-us3-datadoghq.com",
              "browser-intake-us5-datadoghq.com",
              "browser-intake-ap1-datadoghq.com",
              "browser-intake-ap2-datadoghq.com",
              "browser-intake-datadoghq.eu"
            ]
          }
        }
      },
      {
        url: +"{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "browser-intake-datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: +"https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "api",
          }
        }
      }
    ],
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/datadog_api_client/configuration.rb', line 576

def server_settings
  [
    {
      url: +"https://{subdomain}.{site}",
      description: "No description provided",
      variables: {
        site: {
          description: "The regional site for Datadog customers.",
          default_value: "datadoghq.com",
          enum_values: [
            "datadoghq.com",
            "us3.datadoghq.com",
            "us5.datadoghq.com",
            "ap1.datadoghq.com",
            "ap2.datadoghq.com",
            "datadoghq.eu",
            "ddog-gov.com",
            "us2.ddog-gov.com"
          ]
        },
        subdomain: {
          description: "The subdomain where the API is deployed.",
          default_value: "api",
        }
      }
    },
    {
      url: +"{protocol}://{name}",
      description: "No description provided",
      variables: {
        name: {
          description: "Full site DNS name.",
          default_value: "api.datadoghq.com",
        },
        protocol: {
          description: "The protocol for accessing the API.",
          default_value: "https",
        }
      }
    },
    {
      url: +"https://{subdomain}.{site}",
      description: "No description provided",
      variables: {
        site: {
          description: "Any Datadog deployment.",
          default_value: "datadoghq.com",
        },
        subdomain: {
          description: "The subdomain where the API is deployed.",
          default_value: "api",
        }
      }
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'lib/datadog_api_client/configuration.rb', line 1094

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end