Class: Grafana::Api::Dashboards

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/dashboards.rb

Defined Under Namespace

Classes: PublicDashboards, Uid

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Dashboards

Returns a new instance of Dashboards.



5
6
7
 
# File 'lib/grafana-api/api/dashboards.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#db(save_dashboard_command:) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/grafana-api/api/dashboards.rb', line 9

def db(save_dashboard_command:)
  raise ArgumentError, 'save_dashboard_command is required' if save_dashboard_command.nil?

  @connection.call(
    :POST,
    '/dashboards/db',
    type: Grafana::Api::Models::PostDashboard200Response,
    auth: ['api_key', 'basic'],
    body: save_dashboard_command
  )
end

#home ⇒ Object 



21
22
23
24
25
26
27
28
 
# File 'lib/grafana-api/api/dashboards.rb', line 21

def home
  @connection.call(
    :GET,
    '/dashboards/home',
    type: Grafana::Api::Models::GetHomeDashboardResponse,
    auth: ['api_key', 'basic']
  )
end

#import(import_dashboard_request:) ⇒ Object

Raises:

  • (ArgumentError) 


30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/grafana-api/api/dashboards.rb', line 30

def import(import_dashboard_request:)
  raise ArgumentError, 'import_dashboard_request is required' if import_dashboard_request.nil?

  @connection.call(
    :POST,
    '/dashboards/import',
    type: Grafana::Api::Models::ImportDashboardResponse,
    auth: ['api_key', 'basic'],
    body: import_dashboard_request
  )
end

#interpolate ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/grafana-api/api/dashboards.rb', line 42

def interpolate
  @connection.call(
    :POST,
    '/dashboards/interpolate',
    type: nil,
    auth: ['api_key', 'basic']
  )
end

#tags ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/grafana-api/api/dashboards.rb', line 51

def tags
  @connection.call(
    :GET,
    '/dashboards/tags',
    type: [Grafana::Api::Models::DashboardTagCloudItem],
    auth: ['api_key', 'basic']
  )
end