Class: DatadogAPIClient::V1::DashboardsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/dashboards_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ DashboardsAPI

Returns a new instance of DashboardsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_dashboard(body, opts = {}) ⇒ Object

Create a new dashboard.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 29

def create_dashboard(body, opts = {})
  data, _status_code, _headers = create_dashboard_with_http_info(body, opts)
  data
end

#create_dashboard_with_http_info(body, opts = {}) ⇒ Array<(Dashboard, Integer, Hash)>

Create a new dashboard.

Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the ‘as_count()` or `as_rate()` modifiers appended. Refer to the following [documentation](docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers.

Parameters:

  • body (Dashboard) —

    Create a dashboard request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Dashboard, Integer, Hash)>) —

    Dashboard data, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 42

def create_dashboard_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.create_dashboard ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.create_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Dashboard'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#create_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_public_dashboard(body, opts = {}) ⇒ Object

Create a shared dashboard.

See Also:



97
98
99
100
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 97

def create_public_dashboard(body, opts = {})
  data, _status_code, _headers = create_public_dashboard_with_http_info(body, opts)
  data
end

#create_public_dashboard_with_http_info(body, opts = {}) ⇒ Array<(SharedDashboard, Integer, Hash)>

Create a shared dashboard.

Share a specified private dashboard, generating a URL at which it can be publicly viewed.

Parameters:

  • body (SharedDashboard) —

    Create a shared dashboard request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SharedDashboard, Integer, Hash)>) —

    SharedDashboard data, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 109

def create_public_dashboard_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.create_public_dashboard ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.create_public_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/public'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'SharedDashboard'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_public_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#create_public_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dashboard(dashboard_id, opts = {}) ⇒ Object

Delete a dashboard.

See Also:



164
165
166
167
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 164

def delete_dashboard(dashboard_id, opts = {})
  data, _status_code, _headers = delete_dashboard_with_http_info(dashboard_id, opts)
  data
end

#delete_dashboard_with_http_info(dashboard_id, opts = {}) ⇒ Array<(DashboardDeleteResponse, Integer, Hash)>

Delete a dashboard.

Delete a dashboard using the specified ID.

Parameters:

  • dashboard_id (String) —

    The ID of the dashboard.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DashboardDeleteResponse, Integer, Hash)>) —

    DashboardDeleteResponse data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 176

def delete_dashboard_with_http_info(dashboard_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.delete_dashboard ...'
  end
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling DashboardsAPI.delete_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/{dashboard_id}'.sub('{dashboard_id}', CGI.escape(dashboard_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DashboardDeleteResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#delete_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dashboards(body, opts = {}) ⇒ Object

Delete dashboards.

See Also:



229
230
231
232
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 229

def delete_dashboards(body, opts = {})
  delete_dashboards_with_http_info(body, opts)
  nil
end

#delete_dashboards_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete dashboards.

Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed).

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 241

def delete_dashboards_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.delete_dashboards ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.delete_dashboards"
  end
  # resource path
  local_var_path = '/api/v1/dashboard'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_dashboards,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#delete_dashboards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_public_dashboard(token, opts = {}) ⇒ Object

Revoke a shared dashboard URL.

See Also:



296
297
298
299
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 296

def delete_public_dashboard(token, opts = {})
  data, _status_code, _headers = delete_public_dashboard_with_http_info(token, opts)
  data
end

#delete_public_dashboard_invitation(token, body, opts = {}) ⇒ Object

Revoke shared dashboard invitations.

See Also:



361
362
363
364
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 361

def delete_public_dashboard_invitation(token, body, opts = {})
  delete_public_dashboard_invitation_with_http_info(token, body, opts)
  nil
end

#delete_public_dashboard_invitation_with_http_info(token, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Revoke shared dashboard invitations.

Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.

Parameters:

  • token (String) —

    The token of the shared dashboard.

  • body (SharedDashboardInvites) —

    Shared Dashboard Invitation deletion request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 374

def delete_public_dashboard_invitation_with_http_info(token, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.delete_public_dashboard_invitation ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DashboardsAPI.delete_public_dashboard_invitation"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.delete_public_dashboard_invitation"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/public/{token}/invitation'.sub('{token}', CGI.escape(token.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_public_dashboard_invitation,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#delete_public_dashboard_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_public_dashboard_with_http_info(token, opts = {}) ⇒ Array<(DeleteSharedDashboardResponse, Integer, Hash)>

Revoke a shared dashboard URL.

Revoke the public URL for a dashboard (rendering it private) associated with the specified token.

Parameters:

  • token (String) —

    The token of the shared dashboard.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 308

def delete_public_dashboard_with_http_info(token, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.delete_public_dashboard ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DashboardsAPI.delete_public_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/public/{token}'.sub('{token}', CGI.escape(token.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteSharedDashboardResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_public_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#delete_public_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dashboard(dashboard_id, opts = {}) ⇒ Object

Get a dashboard.

See Also:



433
434
435
436
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 433

def get_dashboard(dashboard_id, opts = {})
  data, _status_code, _headers = get_dashboard_with_http_info(dashboard_id, opts)
  data
end

#get_dashboard_with_http_info(dashboard_id, opts = {}) ⇒ Array<(Dashboard, Integer, Hash)>

Get a dashboard.

Get a dashboard using the specified ID.

Parameters:

  • dashboard_id (String) —

    The ID of the dashboard.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Dashboard, Integer, Hash)>) —

    Dashboard data, response status code and response headers



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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 445

def get_dashboard_with_http_info(dashboard_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.get_dashboard ...'
  end
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling DashboardsAPI.get_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/{dashboard_id}'.sub('{dashboard_id}', CGI.escape(dashboard_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Dashboard'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#get_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_public_dashboard(token, opts = {}) ⇒ Object

Get a shared dashboard.

See Also:



498
499
500
501
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 498

def get_public_dashboard(token, opts = {})
  data, _status_code, _headers = get_public_dashboard_with_http_info(token, opts)
  data
end

#get_public_dashboard_invitations(token, opts = {}) ⇒ Object

Get all invitations for a shared dashboard.

See Also:



563
564
565
566
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 563

def get_public_dashboard_invitations(token, opts = {})
  data, _status_code, _headers = get_public_dashboard_invitations_with_http_info(token, opts)
  data
end

#get_public_dashboard_invitations_with_http_info(token, opts = {}) ⇒ Array<(SharedDashboardInvites, Integer, Hash)>

Get all invitations for a shared dashboard.

Describe the invitations that exist for the given shared dashboard (paginated).

Parameters:

  • token (String) —

    Token of the shared dashboard for which to fetch invitations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records to return in a single request.

  • :page_number (Integer) —

    The page to access (base 0).

Returns:

  • (Array<(SharedDashboardInvites, Integer, Hash)>) —

    SharedDashboardInvites data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 577

def get_public_dashboard_invitations_with_http_info(token, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.get_public_dashboard_invitations ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DashboardsAPI.get_public_dashboard_invitations"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/public/{token}/invitation'.sub('{token}', CGI.escape(token.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SharedDashboardInvites'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_public_dashboard_invitations,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#get_public_dashboard_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_public_dashboard_with_http_info(token, opts = {}) ⇒ Array<(SharedDashboard, Integer, Hash)>

Get a shared dashboard.

Fetch an existing shared dashboard’s sharing metadata associated with the specified token.

Parameters:

  • token (String) —

    The token of the shared dashboard. Generated when a dashboard is shared.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SharedDashboard, Integer, Hash)>) —

    SharedDashboard data, response status code and response headers



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 510

def get_public_dashboard_with_http_info(token, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.get_public_dashboard ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DashboardsAPI.get_public_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/public/{token}'.sub('{token}', CGI.escape(token.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SharedDashboard'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_public_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#get_public_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_dashboards(opts = {}) ⇒ Object

Get all dashboards.

See Also:



632
633
634
635
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 632

def list_dashboards(opts = {})
  data, _status_code, _headers = list_dashboards_with_http_info(opts)
  data
end

#list_dashboards_with_http_info(opts = {}) ⇒ Array<(DashboardSummary, Integer, Hash)>

Get all dashboards.

Get all dashboards.

Note: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_shared (Boolean) —

    When ‘true`, this query only returns shared custom created or cloned dashboards.

  • :filter_deleted (Boolean) —

    When ‘true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter`.

  • :count (Integer) —

    The maximum number of dashboards returned in the list.

  • :start (Integer) —

    The specific offset to use as the beginning of the returned response.

Returns:

  • (Array<(DashboardSummary, Integer, Hash)>) —

    DashboardSummary data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 650

def list_dashboards_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.list_dashboards ...'
  end
  # resource path
  local_var_path = '/api/v1/dashboard'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[shared]'] = opts[:'filter_shared'] if !opts[:'filter_shared'].nil?
  query_params[:'filter[deleted]'] = opts[:'filter_deleted'] if !opts[:'filter_deleted'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DashboardSummary'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_dashboards,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#list_dashboards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_dashboards_with_pagination(opts = {}) {|DashboardSummaryDefinition| ... } ⇒ Object

Get all dashboards.

Provide a paginated version of #list_dashboards, returning all items.

To use it you need to use a block: list_dashboards_with_pagination { |item| p item }

Yields:



707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 707

def list_dashboards_with_pagination(opts = {})
    api_version = "V1"
    page_size = @api_client.get_attribute_from_path(opts, "count", 100)
    @api_client.set_attribute_from_path(api_version, opts, "count", Integer, page_size)
    while true do
        response = list_dashboards(opts)
        @api_client.get_attribute_from_path(response, "dashboards").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "dashboards").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "start", Integer, @api_client.get_attribute_from_path(opts, "start", 0) + page_size)
    end
end

#restore_dashboards(body, opts = {}) ⇒ Object

Restore deleted dashboards.

See Also:



724
725
726
727
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 724

def restore_dashboards(body, opts = {})
  restore_dashboards_with_http_info(body, opts)
  nil
end

#restore_dashboards_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Restore deleted dashboards.

Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).

Parameters:

  • body (DashboardRestoreRequest) —

    Restore dashboards request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 736

def restore_dashboards_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.restore_dashboards ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.restore_dashboards"
  end
  # resource path
  local_var_path = '/api/v1/dashboard'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :restore_dashboards,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#restore_dashboards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_public_dashboard_invitation(token, body, opts = {}) ⇒ Object

Send shared dashboard invitation email.

See Also:



791
792
793
794
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 791

def send_public_dashboard_invitation(token, body, opts = {})
  data, _status_code, _headers = send_public_dashboard_invitation_with_http_info(token, body, opts)
  data
end

#send_public_dashboard_invitation_with_http_info(token, body, opts = {}) ⇒ Array<(SharedDashboardInvites, Integer, Hash)>

Send shared dashboard invitation email.

Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard’s share_list.

Parameters:

  • token (String) —

    The token of the shared dashboard.

  • body (SharedDashboardInvites) —

    Shared Dashboard Invitation request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SharedDashboardInvites, Integer, Hash)>) —

    SharedDashboardInvites data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 804

def send_public_dashboard_invitation_with_http_info(token, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.send_public_dashboard_invitation ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DashboardsAPI.send_public_dashboard_invitation"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.send_public_dashboard_invitation"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/public/{token}/invitation'.sub('{token}', CGI.escape(token.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'SharedDashboardInvites'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :send_public_dashboard_invitation,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#send_public_dashboard_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_dashboard(dashboard_id, body, opts = {}) ⇒ Object

Update a dashboard.

See Also:



863
864
865
866
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 863

def update_dashboard(dashboard_id, body, opts = {})
  data, _status_code, _headers = update_dashboard_with_http_info(dashboard_id, body, opts)
  data
end

#update_dashboard_with_http_info(dashboard_id, body, opts = {}) ⇒ Array<(Dashboard, Integer, Hash)>

Update a dashboard.

Update a dashboard using the specified ID.

Parameters:

  • dashboard_id (String) —

    The ID of the dashboard.

  • body (Dashboard) —

    Update Dashboard request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Dashboard, Integer, Hash)>) —

    Dashboard data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 876

def update_dashboard_with_http_info(dashboard_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.update_dashboard ...'
  end
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling DashboardsAPI.update_dashboard"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.update_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/{dashboard_id}'.sub('{dashboard_id}', CGI.escape(dashboard_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Dashboard'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#update_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_public_dashboard(token, body, opts = {}) ⇒ Object

Update a shared dashboard.

See Also:



935
936
937
938
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 935

def update_public_dashboard(token, body, opts = {})
  data, _status_code, _headers = update_public_dashboard_with_http_info(token, body, opts)
  data
end

#update_public_dashboard_with_http_info(token, body, opts = {}) ⇒ Array<(SharedDashboard, Integer, Hash)>

Update a shared dashboard.

Update a shared dashboard associated with the specified token.

Parameters:

  • token (String) —

    The token of the shared dashboard.

  • body (SharedDashboardUpdateRequest) —

    Update Dashboard request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SharedDashboard, Integer, Hash)>) —

    SharedDashboard data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/dashboards_api.rb', line 948

def update_public_dashboard_with_http_info(token, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.update_public_dashboard ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DashboardsAPI.update_public_dashboard"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DashboardsAPI.update_public_dashboard"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/public/{token}'.sub('{token}', CGI.escape(token.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'SharedDashboard'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_public_dashboard,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V1"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsAPI#update_public_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end