-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathfleet_automation_api.rb
More file actions
1158 lines (997 loc) · 49 KB
/
Copy pathfleet_automation_api.rb
File metadata and controls
1158 lines (997 loc) · 49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
160
161
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
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
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
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
632
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
=begin
#Datadog API V2 Collection
#Collection of all Datadog Public endpoints.
The version of the OpenAPI document: 1.0
Contact: support@datadoghq.com
Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
This product includes software developed at Datadog (https://www.datadoghq.com/).
Copyright 2020-Present Datadog, Inc.
=end
require 'cgi'
module DatadogAPIClient::V2
class FleetAutomationAPI
attr_accessor :api_client
def initialize(api_client = DatadogAPIClient::APIClient.default)
@api_client = api_client
end
# Cancel a deployment.
#
# @see #cancel_fleet_deployment_with_http_info
def cancel_fleet_deployment(deployment_id, opts = {})
cancel_fleet_deployment_with_http_info(deployment_id, opts)
nil
end
# Cancel a deployment.
#
# Cancel an active deployment and stop all pending operations.
# When you cancel a deployment:
# - All pending operations on hosts that haven't started yet are stopped
# - Operations currently in progress on hosts may complete or be interrupted, depending on their current state
# - Configuration changes or package upgrades already applied to hosts are not rolled back
#
# After cancellation, you can view the final state of the deployment using the GET endpoint to see which hosts
# were successfully updated before the cancellation.
#
# @param deployment_id [String] The unique identifier of the deployment to cancel.
# @param opts [Hash] the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def cancel_fleet_deployment_with_http_info(deployment_id, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.cancel_fleet_deployment".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.cancel_fleet_deployment")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.cancel_fleet_deployment"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.cancel_fleet_deployment ...'
end
# verify the required parameter 'deployment_id' is set
if @api_client.config.client_side_validation && deployment_id.nil?
fail ArgumentError, "Missing the required parameter 'deployment_id' when calling FleetAutomationAPI.cancel_fleet_deployment"
end
# resource path
local_var_path = '/api/unstable/fleet/deployments/{deployment_id}/cancel'.sub('{deployment_id}', CGI.escape(deployment_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(['*/*'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type]
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :cancel_fleet_deployment,
: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 => "V2"
)
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: FleetAutomationAPI#cancel_fleet_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Create a configuration deployment.
#
# @see #create_fleet_deployment_configure_with_http_info
def create_fleet_deployment_configure(body, opts = {})
data, _status_code, _headers = create_fleet_deployment_configure_with_http_info(body, opts)
data
end
# Create a configuration deployment.
#
# Create a new deployment to apply configuration changes
# to a fleet of hosts matching the specified filter query.
#
# This endpoint supports two types of configuration operations:
# - `merge-patch`: Merges the provided patch data with the existing configuration file,
# creating the file if it doesn't exist
# - `delete`: Removes the specified configuration file from the target hosts
#
# The deployment is created and started automatically. You can specify multiple configuration
# operations that will be executed in order on each target host. Use the filter query to target
# specific hosts using the Datadog query syntax.
#
# @param body [FleetDeploymentConfigureCreateRequest] Request payload containing the deployment details.
# @param opts [Hash] the optional parameters
# @return [Array<(FleetDeploymentResponse, Integer, Hash)>] FleetDeploymentResponse data, response status code and response headers
def create_fleet_deployment_configure_with_http_info(body, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.create_fleet_deployment_configure".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_fleet_deployment_configure")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_fleet_deployment_configure"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.create_fleet_deployment_configure ...'
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 FleetAutomationAPI.create_fleet_deployment_configure"
end
# resource path
local_var_path = '/api/unstable/fleet/deployments/configure'
# 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] || 'FleetDeploymentResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :create_fleet_deployment_configure,
: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 => "V2"
)
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: FleetAutomationAPI#create_fleet_deployment_configure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Upgrade hosts.
#
# @see #create_fleet_deployment_upgrade_with_http_info
def create_fleet_deployment_upgrade(body, opts = {})
data, _status_code, _headers = create_fleet_deployment_upgrade_with_http_info(body, opts)
data
end
# Upgrade hosts.
#
# Create and immediately start a new package upgrade
# on hosts matching the specified filter query.
#
# This endpoint allows you to upgrade the Datadog Agent to a specific version
# on hosts matching the specified filter query.
#
# The deployment is created and started automatically. The system will:
# 1. Identify all hosts matching the filter query
# 2. Validate that the specified version is available
# 3. Begin rolling out the package upgrade to the target hosts
#
# @param body [FleetDeploymentPackageUpgradeCreateRequest] Request payload containing the package upgrade details.
# @param opts [Hash] the optional parameters
# @return [Array<(FleetDeploymentResponse, Integer, Hash)>] FleetDeploymentResponse data, response status code and response headers
def create_fleet_deployment_upgrade_with_http_info(body, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.create_fleet_deployment_upgrade".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_fleet_deployment_upgrade")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_fleet_deployment_upgrade"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.create_fleet_deployment_upgrade ...'
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 FleetAutomationAPI.create_fleet_deployment_upgrade"
end
# resource path
local_var_path = '/api/unstable/fleet/deployments/upgrade'
# 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] || 'FleetDeploymentResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :create_fleet_deployment_upgrade,
: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 => "V2"
)
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: FleetAutomationAPI#create_fleet_deployment_upgrade\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Create a schedule.
#
# @see #create_fleet_schedule_with_http_info
def create_fleet_schedule(body, opts = {})
data, _status_code, _headers = create_fleet_schedule_with_http_info(body, opts)
data
end
# Create a schedule.
#
# Create a new schedule for automated package upgrades.
#
# Schedules define when and how often to automatically deploy package upgrades to a fleet
# of hosts. Each schedule includes:
# - A filter query to select target hosts
# - A recurrence rule defining maintenance windows
# - A version strategy (e.g., always latest, or N versions behind latest)
#
# When the schedule triggers during a maintenance window, it automatically creates a
# deployment that upgrades the Datadog Agent to the specified version on all matching hosts.
#
# @param body [FleetScheduleCreateRequest] Request payload containing the schedule details.
# @param opts [Hash] the optional parameters
# @return [Array<(FleetScheduleResponse, Integer, Hash)>] FleetScheduleResponse data, response status code and response headers
def create_fleet_schedule_with_http_info(body, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.create_fleet_schedule".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_fleet_schedule")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_fleet_schedule"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.create_fleet_schedule ...'
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 FleetAutomationAPI.create_fleet_schedule"
end
# resource path
local_var_path = '/api/unstable/fleet/schedules'
# 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] || 'FleetScheduleResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :create_fleet_schedule,
: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 => "V2"
)
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: FleetAutomationAPI#create_fleet_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Delete a schedule.
#
# @see #delete_fleet_schedule_with_http_info
def delete_fleet_schedule(id, opts = {})
delete_fleet_schedule_with_http_info(id, opts)
nil
end
# Delete a schedule.
#
# Delete a schedule permanently.
#
# When you delete a schedule:
# - The schedule is permanently removed and will no longer create deployments
# - Any deployments already created by this schedule are not affected
# - This action cannot be undone
#
# If you want to temporarily stop a schedule from creating deployments, consider
# updating its status to "inactive" instead of deleting it.
#
# @param id [String] The unique identifier of the schedule to delete.
# @param opts [Hash] the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def delete_fleet_schedule_with_http_info(id, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.delete_fleet_schedule".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_fleet_schedule")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_fleet_schedule"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.delete_fleet_schedule ...'
end
# verify the required parameter 'id' is set
if @api_client.config.client_side_validation && id.nil?
fail ArgumentError, "Missing the required parameter 'id' when calling FleetAutomationAPI.delete_fleet_schedule"
end
# resource path
local_var_path = '/api/unstable/fleet/schedules/{id}'.sub('{id}', CGI.escape(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(['*/*'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type]
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :delete_fleet_schedule,
: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 => "V2"
)
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: FleetAutomationAPI#delete_fleet_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Get detailed information about an agent.
#
# @see #get_fleet_agent_info_with_http_info
def get_fleet_agent_info(agent_key, opts = {})
data, _status_code, _headers = get_fleet_agent_info_with_http_info(agent_key, opts)
data
end
# Get detailed information about an agent.
#
# Retrieve detailed information about a specific Datadog Agent.
# This endpoint returns comprehensive information about an agent including:
# - Agent details and metadata
# - Configured integrations organized by status (working, warning, error, missing)
# - Detected integrations
# - Configuration files and layers
#
# @param agent_key [String] The unique identifier (agent key) for the Datadog Agent.
# @param opts [Hash] the optional parameters
# @return [Array<(FleetAgentInfoResponse, Integer, Hash)>] FleetAgentInfoResponse data, response status code and response headers
def get_fleet_agent_info_with_http_info(agent_key, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.get_fleet_agent_info".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_fleet_agent_info")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_fleet_agent_info"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.get_fleet_agent_info ...'
end
# verify the required parameter 'agent_key' is set
if @api_client.config.client_side_validation && agent_key.nil?
fail ArgumentError, "Missing the required parameter 'agent_key' when calling FleetAutomationAPI.get_fleet_agent_info"
end
# resource path
local_var_path = '/api/unstable/fleet/agents/{agent_key}'.sub('{agent_key}', CGI.escape(agent_key.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] || 'FleetAgentInfoResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :get_fleet_agent_info,
: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 => "V2"
)
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: FleetAutomationAPI#get_fleet_agent_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Get a configuration deployment by ID.
#
# @see #get_fleet_deployment_with_http_info
def get_fleet_deployment(deployment_id, opts = {})
data, _status_code, _headers = get_fleet_deployment_with_http_info(deployment_id, opts)
data
end
# Get a configuration deployment by ID.
#
# Retrieve detailed information about a specific deployment using its unique identifier.
# This endpoint returns comprehensive information about a deployment, including:
# - Deployment metadata (ID, type, filter query)
# - Total number of target hosts
# - Current high-level status (pending, running, succeeded, failed)
# - Estimated completion time
# - Configuration operations that were or are being applied
# - Detailed host list: A paginated array of hosts included in this deployment with individual
# host status, current package versions, and any errors
#
# The host list provides visibility into the per-host execution status, allowing you to:
# - Monitor which hosts have completed successfully
# - Identify hosts that are still in progress
# - Investigate failures on specific hosts
# - View current package versions installed on each host (including initial, target, and current
# versions for each package)
#
# Pagination: Use the `limit` and `page` query parameters to paginate through hosts. The response
# includes pagination metadata in the `meta.hosts` field with information about the current page,
# total pages, and total host count. The default page size is 50 hosts, with a maximum of 100.
#
# @param deployment_id [String] The unique identifier of the deployment to retrieve.
# @param opts [Hash] the optional parameters
# @option opts [Integer] :limit Maximum number of hosts to return per page. Default is 50, maximum is 100.
# @option opts [Integer] :page Page index for pagination (zero-based). Use this to retrieve subsequent pages of hosts.
# @return [Array<(FleetDeploymentResponse, Integer, Hash)>] FleetDeploymentResponse data, response status code and response headers
def get_fleet_deployment_with_http_info(deployment_id, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.get_fleet_deployment".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_fleet_deployment")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_fleet_deployment"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.get_fleet_deployment ...'
end
# verify the required parameter 'deployment_id' is set
if @api_client.config.client_side_validation && deployment_id.nil?
fail ArgumentError, "Missing the required parameter 'deployment_id' when calling FleetAutomationAPI.get_fleet_deployment"
end
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FleetAutomationAPI.get_fleet_deployment, must be smaller than or equal to 100.'
end
# resource path
local_var_path = '/api/unstable/fleet/deployments/{deployment_id}'.sub('{deployment_id}', CGI.escape(deployment_id.to_s).gsub('%2F', '/'))
# query parameters
query_params = opts[:query_params] || {}
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'FleetDeploymentResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :get_fleet_deployment,
: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 => "V2"
)
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: FleetAutomationAPI#get_fleet_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Get a schedule by ID.
#
# @see #get_fleet_schedule_with_http_info
def get_fleet_schedule(id, opts = {})
data, _status_code, _headers = get_fleet_schedule_with_http_info(id, opts)
data
end
# Get a schedule by ID.
#
# Retrieve detailed information about a specific schedule using its unique identifier.
#
# This endpoint returns comprehensive information about a schedule, including:
# - Schedule metadata (ID, name, creation/update timestamps)
# - Filter query for selecting target hosts
# - Recurrence rule defining when deployments are triggered
# - Version strategy for package upgrades
# - Current status (active or inactive)
#
# @param id [String] The unique identifier of the schedule to retrieve.
# @param opts [Hash] the optional parameters
# @return [Array<(FleetScheduleResponse, Integer, Hash)>] FleetScheduleResponse data, response status code and response headers
def get_fleet_schedule_with_http_info(id, opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.get_fleet_schedule".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_fleet_schedule")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_fleet_schedule"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.get_fleet_schedule ...'
end
# verify the required parameter 'id' is set
if @api_client.config.client_side_validation && id.nil?
fail ArgumentError, "Missing the required parameter 'id' when calling FleetAutomationAPI.get_fleet_schedule"
end
# resource path
local_var_path = '/api/unstable/fleet/schedules/{id}'.sub('{id}', CGI.escape(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] || 'FleetScheduleResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :get_fleet_schedule,
: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 => "V2"
)
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: FleetAutomationAPI#get_fleet_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# List all Datadog Agents.
#
# @see #list_fleet_agents_with_http_info
def list_fleet_agents(opts = {})
data, _status_code, _headers = list_fleet_agents_with_http_info(opts)
data
end
# List all Datadog Agents.
#
# Retrieve a paginated list of all Datadog Agents.
# This endpoint returns a paginated list of all Datadog Agents with support for pagination, sorting, and filtering.
# Use the `page_number` and `page_size` query parameters to paginate through results.
#
# @param opts [Hash] the optional parameters
# @option opts [Integer] :page_number Page number for pagination (must be greater than 0).
# @option opts [Integer] :page_size Number of results per page (must be greater than 0 and less than or equal to 100).
# @option opts [String] :sort_attribute Attribute to sort by.
# @option opts [Boolean] :sort_descending Sort order (true for descending, false for ascending).
# @option opts [String] :tags Comma-separated list of tags to filter agents.
# @option opts [String] :filter Filter string for narrowing down agent results.
# @return [Array<(FleetAgentsResponse, Integer, Hash)>] FleetAgentsResponse data, response status code and response headers
def list_fleet_agents_with_http_info(opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.list_fleet_agents".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_fleet_agents")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_fleet_agents"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.list_fleet_agents ...'
end
if @api_client.config.client_side_validation && !opts[:'page_number'].nil? && opts[:'page_number'] < 1
fail ArgumentError, 'invalid value for "opts[:"page_number"]" when calling FleetAutomationAPI.list_fleet_agents, must be greater than or equal to 1.'
end
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FleetAutomationAPI.list_fleet_agents, must be smaller than or equal to 100.'
end
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FleetAutomationAPI.list_fleet_agents, must be greater than or equal to 1.'
end
# resource path
local_var_path = '/api/unstable/fleet/agents'
# query parameters
query_params = opts[:query_params] || {}
query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
query_params[:'sort_attribute'] = opts[:'sort_attribute'] if !opts[:'sort_attribute'].nil?
query_params[:'sort_descending'] = opts[:'sort_descending'] if !opts[:'sort_descending'].nil?
query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'FleetAgentsResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :list_fleet_agents,
: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 => "V2"
)
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: FleetAutomationAPI#list_fleet_agents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# List all available Agent versions.
#
# @see #list_fleet_agent_versions_with_http_info
def list_fleet_agent_versions(opts = {})
data, _status_code, _headers = list_fleet_agent_versions_with_http_info(opts)
data
end
# List all available Agent versions.
#
# Retrieve a list of all available Datadog Agent versions.
#
# This endpoint returns the available Agent versions that can be deployed to your fleet.
# These versions are used when creating deployments or configuring schedules for
# automated Agent upgrades.
#
# @param opts [Hash] the optional parameters
# @return [Array<(FleetAgentVersionsResponse, Integer, Hash)>] FleetAgentVersionsResponse data, response status code and response headers
def list_fleet_agent_versions_with_http_info(opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.list_fleet_agent_versions".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_fleet_agent_versions")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_fleet_agent_versions"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.list_fleet_agent_versions ...'
end
# resource path
local_var_path = '/api/unstable/fleet/agent_versions'
# 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] || 'FleetAgentVersionsResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :list_fleet_agent_versions,
: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 => "V2"
)
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: FleetAutomationAPI#list_fleet_agent_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# List all deployments.
#
# @see #list_fleet_deployments_with_http_info
def list_fleet_deployments(opts = {})
data, _status_code, _headers = list_fleet_deployments_with_http_info(opts)
data
end
# List all deployments.
#
# Retrieve a list of all deployments for fleet automation.
# Use the `page_size` and `page_offset` parameters to paginate results.
#
# @param opts [Hash] the optional parameters
# @option opts [Integer] :page_size Number of deployments to return per page. Maximum value is 100.
# @option opts [Integer] :page_offset Index of the first deployment to return. Use this with `page_size` to paginate through results.
# @return [Array<(FleetDeploymentsResponse, Integer, Hash)>] FleetDeploymentsResponse data, response status code and response headers
def list_fleet_deployments_with_http_info(opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.list_fleet_deployments".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_fleet_deployments")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_fleet_deployments"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.list_fleet_deployments ...'
end
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FleetAutomationAPI.list_fleet_deployments, must be smaller than or equal to 100.'
end
# resource path
local_var_path = '/api/unstable/fleet/deployments'
# query parameters
query_params = opts[:query_params] || {}
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
query_params[:'page_offset'] = opts[:'page_offset'] if !opts[:'page_offset'].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] || 'FleetDeploymentsResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :list_fleet_deployments,
: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 => "V2"
)
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: FleetAutomationAPI#list_fleet_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# List all schedules.
#
# @see #list_fleet_schedules_with_http_info
def list_fleet_schedules(opts = {})
data, _status_code, _headers = list_fleet_schedules_with_http_info(opts)
data
end
# List all schedules.
#
# Retrieve a list of all schedules for automated fleet deployments.
#
# Schedules allow you to automate package upgrades by defining maintenance windows
# and recurrence rules. Each schedule automatically creates deployments based on its
# configuration.
#
# @param opts [Hash] the optional parameters
# @return [Array<(FleetSchedulesResponse, Integer, Hash)>] FleetSchedulesResponse data, response status code and response headers
def list_fleet_schedules_with_http_info(opts = {})
unstable_enabled = @api_client.config.unstable_operations["v2.list_fleet_schedules".to_sym]
if unstable_enabled
@api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_fleet_schedules")
else
raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_fleet_schedules"))
end
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FleetAutomationAPI.list_fleet_schedules ...'
end
# resource path
local_var_path = '/api/unstable/fleet/schedules'
# 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] || 'FleetSchedulesResponse'
# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
new_options = opts.merge(
:operation => :list_fleet_schedules,
: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 => "V2"
)
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: FleetAutomationAPI#list_fleet_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Trigger a schedule deployment.
#
# @see #trigger_fleet_schedule_with_http_info
def trigger_fleet_schedule(id, opts = {})
data, _status_code, _headers = trigger_fleet_schedule_with_http_info(id, opts)
data
end
# Trigger a schedule deployment.
#
# Manually trigger a schedule to immediately create and start a deployment.
#
# This endpoint allows you to manually initiate a deployment using the schedule's
# configuration, without waiting for the next scheduled maintenance window. This is
# useful for:
# - Testing a schedule before it runs automatically
# - Performing an emergency update outside the regular maintenance window