Class: Grafana::Api::V1

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

Defined Under Namespace

Classes: SsoSettings

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ V1

Returns a new instance of V1.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#provisioning_alert_rules ⇒ Object 



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

def provisioning_alert_rules
  @connection.call(
    :GET,
    '/v1/provisioning/alert-rules',
    type: [Grafana::Api::Models::ProvisionedAlertRule],
    auth: ['api_key', 'basic']
  )
end

#provisioning_alert_rules_delete(uid:, x_disable_provenance: nil) ⇒ Object

Raises:

  • (ArgumentError) 


18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/grafana-api/api/v1.rb', line 18

def provisioning_alert_rules_delete(uid:, x_disable_provenance: nil)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :DELETE,
    '/v1/provisioning/alert-rules/{UID}'
      .gsub('{UID}', ERB::Util.url_encode(uid.to_s)),
    type: nil,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance }
  )
end

#provisioning_alert_rules_export(download: nil, format: nil, folder_uid: nil, group: nil, rule_uid: nil) ⇒ Object 



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

def provisioning_alert_rules_export(download: nil, format: nil, folder_uid: nil, group: nil, rule_uid: nil)
  @connection.call(
    :GET,
    '/v1/provisioning/alert-rules/export',
    type: Grafana::Api::Models::AlertingFileExport,
    auth: ['api_key', 'basic'],
    query: { 'download' => download, 'format' => format, 'folderUid' => folder_uid, 'group' => group, 'ruleUid' => rule_uid }
  )
end

#provisioning_alert_rules_export_get(uid:, download: nil, format: nil) ⇒ Object

Raises:

  • (ArgumentError) 


41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/grafana-api/api/v1.rb', line 41

def provisioning_alert_rules_export_get(uid:, download: nil, format: nil)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :GET,
    '/v1/provisioning/alert-rules/{UID}/export'
      .gsub('{UID}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::AlertingFileExport,
    auth: ['api_key', 'basic'],
    query: { 'download' => download, 'format' => format }
  )
end

#provisioning_alert_rules_get(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/grafana-api/api/v1.rb', line 54

def provisioning_alert_rules_get(uid:)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :GET,
    '/v1/provisioning/alert-rules/{UID}'
      .gsub('{UID}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::ProvisionedAlertRule,
    auth: ['api_key', 'basic']
  )
end

#provisioning_alert_rules_post(x_disable_provenance: nil, provisioned_alert_rule: nil) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/grafana-api/api/v1.rb', line 66

def provisioning_alert_rules_post(x_disable_provenance: nil, provisioned_alert_rule: nil)
  @connection.call(
    :POST,
    '/v1/provisioning/alert-rules',
    type: Grafana::Api::Models::ProvisionedAlertRule,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: provisioned_alert_rule
  )
end

#provisioning_alert_rules_put(uid:, x_disable_provenance: nil, provisioned_alert_rule: nil) ⇒ Object

Raises:

  • (ArgumentError) 


77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/grafana-api/api/v1.rb', line 77

def provisioning_alert_rules_put(uid:, x_disable_provenance: nil, provisioned_alert_rule: nil)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :PUT,
    '/v1/provisioning/alert-rules/{UID}'
      .gsub('{UID}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::ProvisionedAlertRule,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: provisioned_alert_rule
  )
end

#provisioning_contact_points(name: nil) ⇒ Object 



91
92
93
94
95
96
97
98
99
 
# File 'lib/grafana-api/api/v1.rb', line 91

def provisioning_contact_points(name: nil)
  @connection.call(
    :GET,
    '/v1/provisioning/contact-points',
    type: [Grafana::Api::Models::EmbeddedContactPoint],
    auth: ['api_key', 'basic'],
    query: { 'name' => name }
  )
end

#provisioning_contact_points_delete(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/grafana-api/api/v1.rb', line 101

def provisioning_contact_points_delete(uid:)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :DELETE,
    '/v1/provisioning/contact-points/{UID}'
      .gsub('{UID}', ERB::Util.url_encode(uid.to_s)),
    type: nil,
    auth: ['api_key', 'basic']
  )
end

#provisioning_contact_points_export(download: nil, format: nil, decrypt: nil, name: nil) ⇒ Object 



113
114
115
116
117
118
119
120
121
 
# File 'lib/grafana-api/api/v1.rb', line 113

def provisioning_contact_points_export(download: nil, format: nil, decrypt: nil, name: nil)
  @connection.call(
    :GET,
    '/v1/provisioning/contact-points/export',
    type: Grafana::Api::Models::AlertingFileExport,
    auth: ['api_key', 'basic'],
    query: { 'download' => download, 'format' => format, 'decrypt' => decrypt, 'name' => name }
  )
end

#provisioning_contact_points_post(x_disable_provenance: nil, embedded_contact_point: nil) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/grafana-api/api/v1.rb', line 123

def provisioning_contact_points_post(x_disable_provenance: nil, embedded_contact_point: nil)
  @connection.call(
    :POST,
    '/v1/provisioning/contact-points',
    type: Grafana::Api::Models::EmbeddedContactPoint,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: embedded_contact_point
  )
end

#provisioning_contact_points_put(uid:, x_disable_provenance: nil, embedded_contact_point: nil) ⇒ Object

Raises:

  • (ArgumentError) 


134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/grafana-api/api/v1.rb', line 134

def provisioning_contact_points_put(uid:, x_disable_provenance: nil, embedded_contact_point: nil)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :PUT,
    '/v1/provisioning/contact-points/{UID}'
      .gsub('{UID}', ERB::Util.url_encode(uid.to_s)),
    type: nil,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: embedded_contact_point
  )
end

#provisioning_folder_rule_groups(folder_uid:, group:) ⇒ Object

Raises:

  • (ArgumentError) 


148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/grafana-api/api/v1.rb', line 148

def provisioning_folder_rule_groups(folder_uid:, group:)
  raise ArgumentError, 'folder_uid is required' if folder_uid.nil?
  raise ArgumentError, 'group is required' if group.nil?

  @connection.call(
    :GET,
    '/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}'
      .gsub('{FolderUID}', ERB::Util.url_encode(folder_uid.to_s))
      .gsub('{Group}', ERB::Util.url_encode(group.to_s)),
    type: Grafana::Api::Models::AlertRuleGroup,
    auth: ['api_key', 'basic']
  )
end

#provisioning_folder_rule_groups_delete(folder_uid:, group:) ⇒ Object

Raises:

  • (ArgumentError) 


162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/grafana-api/api/v1.rb', line 162

def provisioning_folder_rule_groups_delete(folder_uid:, group:)
  raise ArgumentError, 'folder_uid is required' if folder_uid.nil?
  raise ArgumentError, 'group is required' if group.nil?

  @connection.call(
    :DELETE,
    '/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}'
      .gsub('{FolderUID}', ERB::Util.url_encode(folder_uid.to_s))
      .gsub('{Group}', ERB::Util.url_encode(group.to_s)),
    type: nil,
    auth: ['api_key', 'basic']
  )
end

#provisioning_folder_rule_groups_export(folder_uid:, group:, download: nil, format: nil) ⇒ Object

Raises:

  • (ArgumentError) 


176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/grafana-api/api/v1.rb', line 176

def provisioning_folder_rule_groups_export(folder_uid:, group:, download: nil, format: nil)
  raise ArgumentError, 'folder_uid is required' if folder_uid.nil?
  raise ArgumentError, 'group is required' if group.nil?

  @connection.call(
    :GET,
    '/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}/export'
      .gsub('{FolderUID}', ERB::Util.url_encode(folder_uid.to_s))
      .gsub('{Group}', ERB::Util.url_encode(group.to_s)),
    type: Grafana::Api::Models::AlertingFileExport,
    auth: ['api_key', 'basic'],
    query: { 'download' => download, 'format' => format }
  )
end

#provisioning_folder_rule_groups_put(folder_uid:, group:, x_disable_provenance: nil, alert_rule_group: nil) ⇒ Object

Raises:

  • (ArgumentError) 


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/grafana-api/api/v1.rb', line 191

def provisioning_folder_rule_groups_put(folder_uid:, group:, x_disable_provenance: nil, alert_rule_group: nil)
  raise ArgumentError, 'folder_uid is required' if folder_uid.nil?
  raise ArgumentError, 'group is required' if group.nil?

  @connection.call(
    :PUT,
    '/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}'
      .gsub('{FolderUID}', ERB::Util.url_encode(folder_uid.to_s))
      .gsub('{Group}', ERB::Util.url_encode(group.to_s)),
    type: Grafana::Api::Models::AlertRuleGroup,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: alert_rule_group
  )
end

#provisioning_mute_timings ⇒ Object 



207
208
209
210
211
212
213
214
 
# File 'lib/grafana-api/api/v1.rb', line 207

def provisioning_mute_timings
  @connection.call(
    :GET,
    '/v1/provisioning/mute-timings',
    type: [Grafana::Api::Models::MuteTimeInterval],
    auth: ['api_key', 'basic']
  )
end

#provisioning_mute_timings_delete(name:, version: nil, x_disable_provenance: nil) ⇒ Object

Raises:

  • (ArgumentError) 


216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/grafana-api/api/v1.rb', line 216

def provisioning_mute_timings_delete(name:, version: nil, x_disable_provenance: nil)
  raise ArgumentError, 'name is required' if name.nil?

  @connection.call(
    :DELETE,
    '/v1/provisioning/mute-timings/{name}'
      .gsub('{name}', ERB::Util.url_encode(name.to_s)),
    type: nil,
    auth: ['api_key', 'basic'],
    query: { 'version' => version },
    headers: { 'X-Disable-Provenance' => x_disable_provenance }
  )
end

#provisioning_mute_timings_export(download: nil, format: nil) ⇒ Object 



230
231
232
233
234
235
236
237
238
 
# File 'lib/grafana-api/api/v1.rb', line 230

def provisioning_mute_timings_export(download: nil, format: nil)
  @connection.call(
    :GET,
    '/v1/provisioning/mute-timings/export',
    type: Grafana::Api::Models::AlertingFileExport,
    auth: ['api_key', 'basic'],
    query: { 'download' => download, 'format' => format }
  )
end

#provisioning_mute_timings_export_get(name:, download: nil, format: nil) ⇒ Object

Raises:

  • (ArgumentError) 


240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/grafana-api/api/v1.rb', line 240

def provisioning_mute_timings_export_get(name:, download: nil, format: nil)
  raise ArgumentError, 'name is required' if name.nil?

  @connection.call(
    :GET,
    '/v1/provisioning/mute-timings/{name}/export'
      .gsub('{name}', ERB::Util.url_encode(name.to_s)),
    type: Grafana::Api::Models::AlertingFileExport,
    auth: ['api_key', 'basic'],
    query: { 'download' => download, 'format' => format }
  )
end

#provisioning_mute_timings_get(name:) ⇒ Object

Raises:

  • (ArgumentError) 


253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/grafana-api/api/v1.rb', line 253

def provisioning_mute_timings_get(name:)
  raise ArgumentError, 'name is required' if name.nil?

  @connection.call(
    :GET,
    '/v1/provisioning/mute-timings/{name}'
      .gsub('{name}', ERB::Util.url_encode(name.to_s)),
    type: Grafana::Api::Models::MuteTimeInterval,
    auth: ['api_key', 'basic']
  )
end

#provisioning_mute_timings_post(x_disable_provenance: nil, mute_time_interval: nil) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/grafana-api/api/v1.rb', line 265

def provisioning_mute_timings_post(x_disable_provenance: nil, mute_time_interval: nil)
  @connection.call(
    :POST,
    '/v1/provisioning/mute-timings',
    type: Grafana::Api::Models::MuteTimeInterval,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: mute_time_interval
  )
end

#provisioning_mute_timings_put(name:, x_disable_provenance: nil, mute_time_interval: nil) ⇒ Object

Raises:

  • (ArgumentError) 


276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/grafana-api/api/v1.rb', line 276

def provisioning_mute_timings_put(name:, x_disable_provenance: nil, mute_time_interval: nil)
  raise ArgumentError, 'name is required' if name.nil?

  @connection.call(
    :PUT,
    '/v1/provisioning/mute-timings/{name}'
      .gsub('{name}', ERB::Util.url_encode(name.to_s)),
    type: Grafana::Api::Models::MuteTimeInterval,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: mute_time_interval
  )
end

#provisioning_policies ⇒ Object 



290
291
292
293
294
295
296
297
 
# File 'lib/grafana-api/api/v1.rb', line 290

def provisioning_policies
  @connection.call(
    :GET,
    '/v1/provisioning/policies',
    type: Grafana::Api::Models::Route,
    auth: ['api_key', 'basic']
  )
end

#provisioning_policies_delete ⇒ Object 



299
300
301
302
303
304
305
306
 
# File 'lib/grafana-api/api/v1.rb', line 299

def provisioning_policies_delete
  @connection.call(
    :DELETE,
    '/v1/provisioning/policies',
    type: nil,
    auth: ['api_key', 'basic']
  )
end

#provisioning_policies_export ⇒ Object 



308
309
310
311
312
313
314
315
 
# File 'lib/grafana-api/api/v1.rb', line 308

def provisioning_policies_export
  @connection.call(
    :GET,
    '/v1/provisioning/policies/export',
    type: Grafana::Api::Models::AlertingFileExport,
    auth: ['api_key', 'basic']
  )
end

#provisioning_policies_put(x_disable_provenance: nil, route: nil) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/grafana-api/api/v1.rb', line 317

def provisioning_policies_put(x_disable_provenance: nil, route: nil)
  @connection.call(
    :PUT,
    '/v1/provisioning/policies',
    type: nil,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: route
  )
end

#provisioning_templates ⇒ Object 



328
329
330
331
332
333
334
335
 
# File 'lib/grafana-api/api/v1.rb', line 328

def provisioning_templates
  @connection.call(
    :GET,
    '/v1/provisioning/templates',
    type: [Grafana::Api::Models::NotificationTemplate],
    auth: ['api_key', 'basic']
  )
end

#provisioning_templates_delete(name:, version: nil) ⇒ Object

Raises:

  • (ArgumentError) 


337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/grafana-api/api/v1.rb', line 337

def provisioning_templates_delete(name:, version: nil)
  raise ArgumentError, 'name is required' if name.nil?

  @connection.call(
    :DELETE,
    '/v1/provisioning/templates/{name}'
      .gsub('{name}', ERB::Util.url_encode(name.to_s)),
    type: nil,
    auth: ['api_key', 'basic'],
    query: { 'version' => version }
  )
end

#provisioning_templates_get(name:) ⇒ Object

Raises:

  • (ArgumentError) 


350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/grafana-api/api/v1.rb', line 350

def provisioning_templates_get(name:)
  raise ArgumentError, 'name is required' if name.nil?

  @connection.call(
    :GET,
    '/v1/provisioning/templates/{name}'
      .gsub('{name}', ERB::Util.url_encode(name.to_s)),
    type: Grafana::Api::Models::NotificationTemplate,
    auth: ['api_key', 'basic']
  )
end

#provisioning_templates_put(name:, x_disable_provenance: nil, notification_template_content: nil) ⇒ Object

Raises:

  • (ArgumentError) 


362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/grafana-api/api/v1.rb', line 362

def provisioning_templates_put(name:, x_disable_provenance: nil, notification_template_content: nil)
  raise ArgumentError, 'name is required' if name.nil?

  @connection.call(
    :PUT,
    '/v1/provisioning/templates/{name}'
      .gsub('{name}', ERB::Util.url_encode(name.to_s)),
    type: Grafana::Api::Models::NotificationTemplate,
    auth: ['api_key', 'basic'],
    headers: { 'X-Disable-Provenance' => x_disable_provenance },
    body: notification_template_content
  )
end