1+ <!DOCTYPE html>
2+ < html >
3+ < head >
4+ < meta charset ="utf-8 ">
5+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
6+ < title >
7+ Module: DatadogAPIClient
8+
9+ — datadog-api-client 2.52.0 documentation
10+
11+ </ title >
12+
13+ < link rel ="stylesheet " href ="css/style.css " type ="text/css ">
14+
15+ < link rel ="stylesheet " href ="css/common.css " type ="text/css ">
16+
17+ < script type ="text/javascript ">
18+ pathId = "DatadogAPIClient" ;
19+ relpath = '' ;
20+ </ script >
21+
22+
23+ < script type ="text/javascript " charset ="utf-8 " src ="js/jquery.js "> </ script >
24+
25+ < script type ="text/javascript " charset ="utf-8 " src ="js/app.js "> </ script >
26+
27+
28+ </ head >
29+ < body >
30+ < div class ="nav_wrap ">
31+ < iframe id ="nav " src ="class_list.html?1 "> </ iframe >
32+ < div id ="resizer "> </ div >
33+ </ div >
34+
35+ < div id ="main " tabindex ="-1 ">
36+ < div id ="header ">
37+ < div id ="menu ">
38+
39+ < a href ="_index.html "> Index (D)</ a > »
40+
41+
42+ < span class ="title "> DatadogAPIClient</ span >
43+
44+ </ div >
45+
46+ < div id ="search ">
47+
48+ < a class ="full_list_link " id ="class_list_link "
49+ href ="class_list.html ">
50+
51+ < svg width ="24 " height ="24 ">
52+ < rect x ="0 " y ="4 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
53+ < rect x ="0 " y ="12 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
54+ < rect x ="0 " y ="20 " width ="24 " height ="4 " rx ="1 " ry ="1 "> </ rect >
55+ </ svg >
56+ </ a >
57+
58+ </ div >
59+ < div class ="clear "> </ div >
60+ </ div >
61+
62+ < div id ="content "> < h1 > Module: DatadogAPIClient
63+
64+
65+
66+ </ h1 >
67+ < div class ="box_info ">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+ < dl >
80+ < dt > Defined in:</ dt >
81+ < dd > lib/datadog_api_client/version.rb< span class ="defines "> ,< br >
82+ lib/datadog_api_client/models.rb,< br > lib/datadog_api_client/inflector.rb,< br > lib/datadog_api_client/api_client.rb,< br > lib/datadog_api_client/user_agent.rb,< br > lib/datadog_api_client/configuration.rb</ span >
83+
84+ </ dd >
85+ </ dl >
86+
87+ </ div >
88+
89+ < h2 > Overview</ h2 > < div class ="docstring ">
90+ < div class ="discussion ">
91+ < h1 id ="datadog-api-v2-collection "> Datadog API V2 Collection</ h1 >
92+
93+ < h1 id ="collection-of-all-datadog-public-endpoints "> Collection of all Datadog Public endpoints.</ h1 >
94+
95+ < p > The version of the OpenAPI document: 1.0
96+ Contact: < a href ="mailto:support@datadoghq.com "> support@datadoghq.com</ a >
97+ Generated by: < a href ="https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator "> https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator</ a > </ p >
98+
99+ < p > Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
100+ This product includes software developed at Datadog (< a href ="https://www.datadoghq.com/ "> https://www.datadoghq.com/</ a > ).
101+ Copyright 2020-Present Datadog, Inc.</ p >
102+
103+
104+ </ div >
105+ </ div >
106+ < div class ="tags ">
107+
108+
109+ </ div > < h2 > Defined Under Namespace</ h2 >
110+ < p class ="children ">
111+
112+
113+ < strong class ="modules "> Modules:</ strong > < span class ='object_link '> < a href ="DatadogAPIClient/V1.html " title ="DatadogAPIClient::V1 (module) "> V1</ a > </ span > , < span class ='object_link '> < a href ="DatadogAPIClient/V2.html " title ="DatadogAPIClient::V2 (module) "> V2</ a > </ span >
114+
115+
116+
117+ < strong class ="classes "> Classes:</ strong > < span class ='object_link '> < a href ="DatadogAPIClient/APIClient.html " title ="DatadogAPIClient::APIClient (class) "> APIClient</ a > </ span > , < span class ='object_link '> < a href ="DatadogAPIClient/APIError.html " title ="DatadogAPIClient::APIError (class) "> APIError</ a > </ span > , < span class ='object_link '> < a href ="DatadogAPIClient/Configuration.html " title ="DatadogAPIClient::Configuration (class) "> Configuration</ a > </ span > , < span class ='object_link '> < a href ="DatadogAPIClient/DatadogAPIClientInflector.html " title ="DatadogAPIClient::DatadogAPIClientInflector (class) "> DatadogAPIClientInflector</ a > </ span > , < span class ='object_link '> < a href ="DatadogAPIClient/EnumAttributeValidator.html " title ="DatadogAPIClient::EnumAttributeValidator (class) "> EnumAttributeValidator</ a > </ span > , < span class ='object_link '> < a href ="DatadogAPIClient/UnparsedObject.html " title ="DatadogAPIClient::UnparsedObject (class) "> UnparsedObject</ a > </ span >
118+
119+
120+ </ p >
121+
122+
123+ < h2 >
124+ Constant Summary
125+ < small > < a href ="# " class ="constants_summary_toggle "> collapse</ a > </ small >
126+ </ h2 >
127+
128+ < dl class ="constants ">
129+
130+ < dt id ="VERSION-constant " class =""> VERSION =
131+
132+ </ dt >
133+ < dd > < pre class ="code "> < span class ='tstring '> < span class ='tstring_beg '> '</ span > < span class ='tstring_content '> 2.52.0</ span > < span class ='tstring_end '> '</ span > </ span > </ pre > </ dd >
134+
135+ < dt id ="USER_AGENT-constant " class =""> USER_AGENT =
136+
137+ </ dt >
138+ < dd > < pre class ="code "> < span class ='id identifier rubyid_format '> format</ span > < span class ='lparen '> (</ span >
139+ < span class ='tstring '> < span class ='tstring_beg '> '</ span > < span class ='tstring_content '> datadog-api-client-ruby/%<version>s (ruby %<ruver>s; os %<os>s; arch %<arch>s; httparty-version %<httparty_version>s)</ span > < span class ='tstring_end '> '</ span > </ span > < span class ='comma '> ,</ span >
140+ < span class ='label '> version:</ span > < span class ='const '> < span class ='object_link '> < a href ="#VERSION-constant " title ="DatadogAPIClient::VERSION (constant) "> VERSION</ a > </ span > </ span > < span class ='comma '> ,</ span >
141+ < span class ='label '> ruver:</ span > < span class ='const '> RUBY_VERSION</ span > < span class ='comma '> ,</ span >
142+ < span class ='label '> os:</ span > < span class ='const '> RbConfig</ span > < span class ='op '> ::</ span > < span class ='const '> CONFIG</ span > < span class ='lbracket '> [</ span > < span class ='tstring '> < span class ='tstring_beg '> '</ span > < span class ='tstring_content '> host_os</ span > < span class ='tstring_end '> '</ span > </ span > < span class ='rbracket '> ]</ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_downcase '> downcase</ span > < span class ='comma '> ,</ span >
143+ < span class ='label '> arch:</ span > < span class ='const '> RbConfig</ span > < span class ='op '> ::</ span > < span class ='const '> CONFIG</ span > < span class ='lbracket '> [</ span > < span class ='tstring '> < span class ='tstring_beg '> '</ span > < span class ='tstring_content '> host_cpu</ span > < span class ='tstring_end '> '</ span > </ span > < span class ='rbracket '> ]</ span > < span class ='comma '> ,</ span >
144+ < span class ='label '> httparty_version:</ span > < span class ='const '> HTTParty</ span > < span class ='op '> ::</ span > < span class ='const '> VERSION</ span >
145+ < span class ='rparen '> )</ span > </ pre > </ dd >
146+
147+ </ dl >
148+
149+
150+
151+
152+
153+
154+
155+
156+
157+ < h2 >
158+ Class Method Summary
159+ < small > < a href ="# " class ="summary_toggle "> collapse</ a > </ small >
160+ </ h2 >
161+
162+ < ul class ="summary ">
163+
164+ < li class ="public ">
165+ < span class ="summary_signature ">
166+
167+ < a href ="#configure-class_method " title ="configure (class method) "> .< strong > configure</ strong > ⇒ Object </ a >
168+
169+
170+
171+ </ span >
172+
173+
174+
175+
176+
177+
178+
179+
180+
181+ < span class ="summary_desc "> < div class ='inline '> < p > Customize default settings for the SDK using block.</ p >
182+ </ div > </ span >
183+
184+ </ li >
185+
186+
187+ </ ul >
188+
189+
190+
191+
192+
193+ < div id ="class_method_details " class ="method_details_list ">
194+ < h2 > Class Method Details</ h2 >
195+
196+
197+ < div class ="method_details first ">
198+ < h3 class ="signature first " id ="configure-class_method ">
199+
200+ .< strong > configure</ strong > ⇒ < tt > Object</ tt >
201+
202+
203+
204+
205+
206+ </ h3 > < div class ="docstring ">
207+ < div class ="discussion ">
208+ < p > Customize default settings for the SDK using block.
209+ DatadogAPIClient::V2.configure do |config|
210+ config.username = "xxx"
211+ config.password = "xxx"
212+ end
213+ If no block given, return the default Configuration object.</ p >
214+
215+
216+ </ div >
217+ </ div >
218+ < div class ="tags ">
219+
220+
221+ </ div > < table class ="source_code ">
222+ < tr >
223+ < td >
224+ < pre class ="lines ">
225+
226+
227+ 35
228+ 36
229+ 37
230+ 38
231+ 39
232+ 40
233+ 41</ pre >
234+ </ td >
235+ < td >
236+ < pre class ="code "> < span class ="info file "> # File 'lib/datadog_api_client/models.rb', line 35</ span >
237+
238+ < span class ='kw '> def</ span > < span class ='id identifier rubyid_configure '> configure</ span >
239+ < span class ='kw '> if</ span > < span class ='id identifier rubyid_block_given? '> block_given?</ span >
240+ < span class ='kw '> yield</ span > < span class ='lparen '> (</ span > < span class ='const '> < span class ='object_link '> < a href ="DatadogAPIClient/Configuration.html " title ="DatadogAPIClient::Configuration (class) "> Configuration</ a > </ span > </ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_default '> < span class ='object_link '> < a href ="DatadogAPIClient/Configuration.html#default-class_method " title ="DatadogAPIClient::Configuration.default (method) "> default</ a > </ span > </ span > < span class ='rparen '> )</ span >
241+ < span class ='kw '> else</ span >
242+ < span class ='const '> < span class ='object_link '> < a href ="DatadogAPIClient/Configuration.html " title ="DatadogAPIClient::Configuration (class) "> Configuration</ a > </ span > </ span > < span class ='period '> .</ span > < span class ='id identifier rubyid_default '> < span class ='object_link '> < a href ="DatadogAPIClient/Configuration.html#default-class_method " title ="DatadogAPIClient::Configuration.default (method) "> default</ a > </ span > </ span >
243+ < span class ='kw '> end</ span >
244+ < span class ='kw '> end</ span > </ pre >
245+ </ td >
246+ </ tr >
247+ </ table >
248+ </ div >
249+
250+ </ div >
251+
252+ </ div >
253+
254+ < div id ="footer ">
255+ Generated on Mon Apr 13 22:57:01 2026 by
256+ < a href ="https://yardoc.org " title ="Yay! A Ruby Documentation Tool " target ="_parent "> yard</ a >
257+ 0.9.40 (ruby-2.7.8).
258+ </ div >
259+
260+ </ div >
261+ </ body >
262+ </ html >
![pull[bot]](https://avatars.githubusercontent.com/in/12910?v=4&size=40){kind=avatar}
0 commit comments