@itentialopensource/adapter-datadog 0.6.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CALLS.md +1800 -22
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +161 -333
- package/adapterBase.js +549 -879
- package/changelogs/CHANGELOG.md +86 -0
- package/metadata.json +49 -0
- package/package.json +25 -25
- package/pronghorn.json +1564 -1225
- package/propertiesSchema.json +431 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +156 -0
- package/report/adapter-openapi.yaml +131 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691508986112.json +120 -0
- package/report/updateReport1692202301848.json +120 -0
- package/report/updateReport1692203389397.json +120 -0
- package/report/updateReport1694469996136.json +120 -0
- package/report/updateReport1698423169409.json +120 -0
- package/sampleProperties.json +64 -3
- package/test/integration/adapterTestBasicGet.js +2 -4
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +338 -112
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +2 -2
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/pre-commit.sh +2 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +89 -34
- package/utils/tbUtils.js +41 -21
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +9 -6
- package/workflows/README.md +0 -3
package/CALLS.md
CHANGED
|
@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
19
19
|
</tr>
|
|
20
20
|
<tr>
|
|
21
21
|
<td style="padding:15px">healthCheck(callback)</td>
|
|
22
|
-
<td style="padding:15px">This call ensures that the adapter can communicate with Datadog. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
|
|
22
|
+
<td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Datadog. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
|
|
23
23
|
<td style="padding:15px">No</td>
|
|
24
24
|
</tr>
|
|
25
25
|
<tr>
|
|
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
29
29
|
</tr>
|
|
30
30
|
<tr>
|
|
31
31
|
<td style="padding:15px">encryptProperty(property, technique, callback)</td>
|
|
32
|
-
<td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Datadog.</td>
|
|
32
|
+
<td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Datadog.</td>
|
|
33
33
|
<td style="padding:15px">No</td>
|
|
34
34
|
</tr>
|
|
35
35
|
<tr>
|
|
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
37
37
|
<td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
|
|
38
38
|
<td style="padding:15px">Yes</td>
|
|
39
39
|
</tr>
|
|
40
|
-
<tr>
|
|
41
|
-
<td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
|
|
42
|
-
<td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
|
|
43
|
-
<td style="padding:15px">Yes</td>
|
|
44
|
-
</tr>
|
|
45
40
|
<tr>
|
|
46
41
|
<td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
|
|
47
42
|
<td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
|
|
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
57
52
|
<td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
|
|
58
53
|
<td style="padding:15px">Yes</td>
|
|
59
54
|
</tr>
|
|
55
|
+
<tr>
|
|
56
|
+
<td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
|
|
57
|
+
<td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
|
|
58
|
+
<td style="padding:15px">Yes</td>
|
|
59
|
+
</tr>
|
|
60
60
|
<tr>
|
|
61
61
|
<td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
|
|
62
62
|
<td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
|
|
63
63
|
<td style="padding:15px">Yes</td>
|
|
64
64
|
</tr>
|
|
65
|
-
|
|
66
65
|
<tr>
|
|
67
66
|
<td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
|
|
68
67
|
<td style="padding:15px">This call will return the results of a healthcheck.</td>
|
|
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
83
82
|
<td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
|
|
84
83
|
<td style="padding:15px">Yes</td>
|
|
85
84
|
</tr>
|
|
85
|
+
<tr>
|
|
86
|
+
<td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
|
|
87
|
+
<td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
|
|
88
|
+
<td style="padding:15px">Yes</td>
|
|
89
|
+
</tr>
|
|
90
|
+
<tr>
|
|
91
|
+
<td style="padding:15px">iapActivateTasks(tasks, callback)</td>
|
|
92
|
+
<td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
|
|
93
|
+
<td style="padding:15px">Yes</td>
|
|
94
|
+
</tr>
|
|
95
|
+
<tr>
|
|
96
|
+
<td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
|
|
97
|
+
<td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
|
|
98
|
+
<td style="padding:15px">Yes</td>
|
|
99
|
+
</tr>
|
|
86
100
|
<tr>
|
|
87
101
|
<td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
|
|
88
102
|
<td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
|
|
@@ -94,19 +108,42 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
94
108
|
<td style="padding:15px">Yes</td>
|
|
95
109
|
</tr>
|
|
96
110
|
<tr>
|
|
97
|
-
<td style="padding:15px">
|
|
98
|
-
<td style="padding:15px">
|
|
99
|
-
<td style="padding:15px">
|
|
111
|
+
<td style="padding:15px">iapRunAdapterLint(callback)</td>
|
|
112
|
+
<td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
|
|
113
|
+
<td style="padding:15px">Yes</td>
|
|
100
114
|
</tr>
|
|
101
115
|
<tr>
|
|
102
|
-
<td style="padding:15px">
|
|
103
|
-
<td style="padding:15px">
|
|
104
|
-
<td style="padding:15px">
|
|
116
|
+
<td style="padding:15px">iapRunAdapterTests(callback)</td>
|
|
117
|
+
<td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
|
|
118
|
+
<td style="padding:15px">Yes</td>
|
|
105
119
|
</tr>
|
|
106
120
|
<tr>
|
|
107
|
-
<td style="padding:15px">
|
|
108
|
-
<td style="padding:15px">This call
|
|
109
|
-
<td style="padding:15px">
|
|
121
|
+
<td style="padding:15px">iapGetAdapterInventory(callback)</td>
|
|
122
|
+
<td style="padding:15px">This call provides some inventory related information about the adapter.</td>
|
|
123
|
+
<td style="padding:15px">Yes</td>
|
|
124
|
+
</tr>
|
|
125
|
+
</table>
|
|
126
|
+
<br>
|
|
127
|
+
|
|
128
|
+
### Adapter Cache Calls
|
|
129
|
+
|
|
130
|
+
These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
|
|
131
|
+
|
|
132
|
+
<table border="1" class="bordered-table">
|
|
133
|
+
<tr>
|
|
134
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
|
|
135
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
136
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
137
|
+
</tr>
|
|
138
|
+
<tr>
|
|
139
|
+
<td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
|
|
140
|
+
<td style="padding:15px">This call populates the adapter cache.</td>
|
|
141
|
+
<td style="padding:15px">Yes</td>
|
|
142
|
+
</tr>
|
|
143
|
+
<tr>
|
|
144
|
+
<td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
|
|
145
|
+
<td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
|
|
146
|
+
<td style="padding:15px">Yes</td>
|
|
110
147
|
</tr>
|
|
111
148
|
</table>
|
|
112
149
|
<br>
|
|
@@ -129,27 +166,27 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
|
|
|
129
166
|
<tr>
|
|
130
167
|
<td style="padding:15px">getDevice(deviceName, callback)</td>
|
|
131
168
|
<td style="padding:15px">This call returns the details of the requested device.</td>
|
|
132
|
-
<td style="padding:15px">
|
|
169
|
+
<td style="padding:15px">No</td>
|
|
133
170
|
</tr>
|
|
134
171
|
<tr>
|
|
135
172
|
<td style="padding:15px">getDevicesFiltered(options, callback)</td>
|
|
136
173
|
<td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
|
|
137
|
-
<td style="padding:15px">
|
|
174
|
+
<td style="padding:15px">No</td>
|
|
138
175
|
</tr>
|
|
139
176
|
<tr>
|
|
140
177
|
<td style="padding:15px">isAlive(deviceName, callback)</td>
|
|
141
178
|
<td style="padding:15px">This call returns whether the device status is active</td>
|
|
142
|
-
<td style="padding:15px">
|
|
179
|
+
<td style="padding:15px">No</td>
|
|
143
180
|
</tr>
|
|
144
181
|
<tr>
|
|
145
182
|
<td style="padding:15px">getConfig(deviceName, format, callback)</td>
|
|
146
183
|
<td style="padding:15px">This call returns the configuration for the selected device.</td>
|
|
147
|
-
<td style="padding:15px">
|
|
184
|
+
<td style="padding:15px">No</td>
|
|
148
185
|
</tr>
|
|
149
186
|
<tr>
|
|
150
187
|
<td style="padding:15px">iapGetDeviceCount(callback)</td>
|
|
151
188
|
<td style="padding:15px">This call returns the count of devices.</td>
|
|
152
|
-
<td style="padding:15px">
|
|
189
|
+
<td style="padding:15px">No</td>
|
|
153
190
|
</tr>
|
|
154
191
|
</table>
|
|
155
192
|
<br>
|
|
@@ -165,5 +202,1746 @@ Specific adapter calls are built based on the API of the Datadog. The Adapter Bu
|
|
|
165
202
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
|
|
166
203
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
167
204
|
</tr>
|
|
205
|
+
<tr>
|
|
206
|
+
<td style="padding:15px">createUser(body, apiKey, applicationKey, callback)</td>
|
|
207
|
+
<td style="padding:15px">### Overview
|
|
208
|
+
|
|
209
|
+
Create a user for your organization.
|
|
210
|
+
|
|
211
|
+
### ARGUMENTS
|
|
212
|
+
|
|
213
|
+
* **`handle`** [*required*]: The user handle, must be a valid email.
|
|
214
|
+
* **`name`** [*optional*, *default*=**None**]: The name of the user.
|
|
215
|
+
* **`access_role`** [*optional*, *default*=**st**]: The access role of the user. Choose from:
|
|
216
|
+
* **st** (standard user),
|
|
217
|
+
* **adm** (admin user),
|
|
218
|
+
* **ro** (read-only user).
|
|
219
|
+
*Note: users can be created with admin access role only with application keys belonging to administrators...(description truncated)</td>
|
|
220
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
221
|
+
<td style="padding:15px">Yes</td>
|
|
222
|
+
</tr>
|
|
223
|
+
<tr>
|
|
224
|
+
<td style="padding:15px">getAllUsers(apiKey, applicationKey, callback)</td>
|
|
225
|
+
<td style="padding:15px">### Overview
|
|
226
|
+
|
|
227
|
+
Get all user for your organization.
|
|
228
|
+
|
|
229
|
+
### Arguments
|
|
230
|
+
|
|
231
|
+
This endpoint takes no JSON argument.</td>
|
|
232
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
233
|
+
<td style="padding:15px">Yes</td>
|
|
234
|
+
</tr>
|
|
235
|
+
<tr>
|
|
236
|
+
<td style="padding:15px">getUser(apiKey, applicationKey, callback)</td>
|
|
237
|
+
<td style="padding:15px">### Overview
|
|
238
|
+
|
|
239
|
+
Get a user details.
|
|
240
|
+
|
|
241
|
+
### Arguments
|
|
242
|
+
|
|
243
|
+
* **`user_handle`** [*required*]: The handle of the user.</td>
|
|
244
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
245
|
+
<td style="padding:15px">Yes</td>
|
|
246
|
+
</tr>
|
|
247
|
+
<tr>
|
|
248
|
+
<td style="padding:15px">updateUser(body, apiKey, applicationKey, callback)</td>
|
|
249
|
+
<td style="padding:15px">### Overview
|
|
250
|
+
|
|
251
|
+
Update a user informations,
|
|
252
|
+
|
|
253
|
+
**Note**: It can only be used with application keys belonging to administrators.
|
|
254
|
+
|
|
255
|
+
##### ARGUMENTS
|
|
256
|
+
* **`id`** [*required*]: The handle of the user.
|
|
257
|
+
* **`name`** [*optional*, *default*=**None**]: The new name of the user.
|
|
258
|
+
* **`email`** [*optional*, *default*=**None**]: The new email of the user.
|
|
259
|
+
* **`disabled`** [*optional*, *default*=**None**]: The new disabled status of the user.
|
|
260
|
+
* **`access_role`** [*optional*, *default*=**st**]: The access role of the...(description truncated)</td>
|
|
261
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
262
|
+
<td style="padding:15px">Yes</td>
|
|
263
|
+
</tr>
|
|
264
|
+
<tr>
|
|
265
|
+
<td style="padding:15px">disableUser(apiKey, applicationKey, callback)</td>
|
|
266
|
+
<td style="padding:15px">### Overview
|
|
267
|
+
|
|
268
|
+
Delete a user from an organization.
|
|
269
|
+
|
|
270
|
+
**Note**: This endpoint can only be used with application keys belonging to administrators.
|
|
271
|
+
|
|
272
|
+
### Arguments
|
|
273
|
+
|
|
274
|
+
* **`id`** [*required*]: The handle of the user.</td>
|
|
275
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
276
|
+
<td style="padding:15px">Yes</td>
|
|
277
|
+
</tr>
|
|
278
|
+
<tr>
|
|
279
|
+
<td style="padding:15px">authenticationCheck(apiKey, callback)</td>
|
|
280
|
+
<td style="padding:15px">All requests to Datadog's API must be authenticated. Requests that write data require *reporting access* and require an `API key`. Requests that read data require *full access* and also require an `application key`.
|
|
281
|
+
|
|
282
|
+
[Manage your account's API and application keys](https://app.datadoghq.com/account/settings#api).
|
|
283
|
+
|
|
284
|
+
This GET call just checks to see if an API call key is valid.</td>
|
|
285
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
286
|
+
<td style="padding:15px">Yes</td>
|
|
287
|
+
</tr>
|
|
288
|
+
<tr>
|
|
289
|
+
<td style="padding:15px">postACheckStatus(body, apiKey, applicationKey, callback)</td>
|
|
290
|
+
<td style="padding:15px">### Overview
|
|
291
|
+
|
|
292
|
+
This POST call allows for you to POST check statuses for use with monitors
|
|
293
|
+
|
|
294
|
+
### Arguments
|
|
295
|
+
|
|
296
|
+
* **`check`** *[required]*: The text for the message
|
|
297
|
+
|
|
298
|
+
* **`host_name`** *[required]*: The name of the host submitting the check
|
|
299
|
+
|
|
300
|
+
* **`status`** *[optional]*: An integer for the status of the check:
|
|
301
|
+
* 0 : OK
|
|
302
|
+
* 1 : WARNING
|
|
303
|
+
* 2 : CRITICAL
|
|
304
|
+
* 3 : UNKNOWN
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
* **`timestamp`** *[optional]*: POSIX timestamp of the event.
|
|
308
|
+
|
|
309
|
+
* **`message`** *[optional]*: A description of why this stat...(description truncated)</td>
|
|
310
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
311
|
+
<td style="padding:15px">Yes</td>
|
|
312
|
+
</tr>
|
|
313
|
+
<tr>
|
|
314
|
+
<td style="padding:15px">replyToComment(body, apiKey, applicationKey, callback)</td>
|
|
315
|
+
<td style="padding:15px">### Overview
|
|
316
|
+
|
|
317
|
+
This POST call allows for you to POST status messages to a previous post via ID.
|
|
318
|
+
|
|
319
|
+
### Arguments
|
|
320
|
+
|
|
321
|
+
* **`message`** [*required*]: The comment text.
|
|
322
|
+
|
|
323
|
+
* **`handle`** [*optional*, *default* = **application key owner**]: The handle of the user making the comment.
|
|
324
|
+
|
|
325
|
+
* **`related_event_id`** [*optional*, *default* = **None**]: The id of another comment or event to reply to.</td>
|
|
326
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
327
|
+
<td style="padding:15px">Yes</td>
|
|
328
|
+
</tr>
|
|
329
|
+
<tr>
|
|
330
|
+
<td style="padding:15px">editAComment(body, apiKey, applicationKey, callback)</td>
|
|
331
|
+
<td style="padding:15px">### Overview
|
|
332
|
+
|
|
333
|
+
This POST call allows for you to change a previously posted comment by commentId
|
|
334
|
+
|
|
335
|
+
### Arguments
|
|
336
|
+
|
|
337
|
+
* **`message`** [*optional*, *default* = **original message**]: The comment text.
|
|
338
|
+
|
|
339
|
+
* **`handle`** [*optional*, *default* = **Application key owner**]: The handle of the user making the comment.</td>
|
|
340
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
341
|
+
<td style="padding:15px">Yes</td>
|
|
342
|
+
</tr>
|
|
343
|
+
<tr>
|
|
344
|
+
<td style="padding:15px">deleteAComment(apiKey, applicationKey, callback)</td>
|
|
345
|
+
<td style="padding:15px">### Overview
|
|
346
|
+
|
|
347
|
+
Thiscall allows for you to DELETE a previously posted comment by with a given .
|
|
348
|
+
|
|
349
|
+
### Arguments
|
|
350
|
+
|
|
351
|
+
This endpoint takes no JSON arguments.</td>
|
|
352
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
353
|
+
<td style="padding:15px">Yes</td>
|
|
354
|
+
</tr>
|
|
355
|
+
<tr>
|
|
356
|
+
<td style="padding:15px">createADashboard(body, apiKey, applicationKey, callback)</td>
|
|
357
|
+
<td style="padding:15px">### Overview
|
|
358
|
+
|
|
359
|
+
Create a Dashboard in Datadog.
|
|
360
|
+
|
|
361
|
+
### Arguments
|
|
362
|
+
|
|
363
|
+
* **`title`** [*required*]: Title of the dashboard.
|
|
364
|
+
* **`widgets`** [*required*]: List of widgets to display on the dashboard. Widget definitions follow this form:
|
|
365
|
+
* **`definition`** [*required*]: [Definition of the widget.](https://docs.datadoghq.com//graphing/widgets)
|
|
366
|
+
* **`id`** [*optional*, *default*=**auto-generated integer**]: ID of the widget.
|
|
367
|
+
* **`layout_type`** [*required*]: Layout type of the dashboard. Available value...(description truncated)</td>
|
|
368
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
369
|
+
<td style="padding:15px">Yes</td>
|
|
370
|
+
</tr>
|
|
371
|
+
<tr>
|
|
372
|
+
<td style="padding:15px">updateADashboard(body, apiKey, applicationKey, callback)</td>
|
|
373
|
+
<td style="padding:15px">### Overview
|
|
374
|
+
|
|
375
|
+
Update a Dashboard in Datadog.
|
|
376
|
+
|
|
377
|
+
### Arguments
|
|
378
|
+
|
|
379
|
+
* **`title`** [*required*]: Title of the dashboard.
|
|
380
|
+
* **`widgets`** [*required*]: List of widgets to display on the dashboard. Widget definitions follow this form:
|
|
381
|
+
* **`definition`** [*required*]: [Definition of the widget.](https://docs.datadoghq.com/graphing/widgets)
|
|
382
|
+
* **`id`** [*optional*, *default*=**auto-generated integer**]: ID of the widget.
|
|
383
|
+
* **`layout_type`** [*required*]: Layout type of the dashboard. Available values...(description truncated)</td>
|
|
384
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
385
|
+
<td style="padding:15px">Yes</td>
|
|
386
|
+
</tr>
|
|
387
|
+
<tr>
|
|
388
|
+
<td style="padding:15px">deleteADashboard(apiKey, applicationKey, callback)</td>
|
|
389
|
+
<td style="padding:15px">### Overview
|
|
390
|
+
|
|
391
|
+
Delete an existing dashboard.
|
|
392
|
+
|
|
393
|
+
### Arguments
|
|
394
|
+
|
|
395
|
+
This end point takes no JSON arguments.</td>
|
|
396
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
397
|
+
<td style="padding:15px">Yes</td>
|
|
398
|
+
</tr>
|
|
399
|
+
<tr>
|
|
400
|
+
<td style="padding:15px">getADashboard(apiKey, applicationKey, callback)</td>
|
|
401
|
+
<td style="padding:15px">### Overview
|
|
402
|
+
|
|
403
|
+
Fetch an existing dashboard's definition.
|
|
404
|
+
|
|
405
|
+
### Arguments
|
|
406
|
+
|
|
407
|
+
This end point takes no JSON arguments.</td>
|
|
408
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
409
|
+
<td style="padding:15px">Yes</td>
|
|
410
|
+
</tr>
|
|
411
|
+
<tr>
|
|
412
|
+
<td style="padding:15px">getAllDashboards(apiKey, applicationKey, callback)</td>
|
|
413
|
+
<td style="padding:15px">### Overview
|
|
414
|
+
|
|
415
|
+
Fetch all existing Dashboards.
|
|
416
|
+
|
|
417
|
+
### Arguments
|
|
418
|
+
|
|
419
|
+
This end point takes no JSON arguments.</td>
|
|
420
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
421
|
+
<td style="padding:15px">Yes</td>
|
|
422
|
+
</tr>
|
|
423
|
+
<tr>
|
|
424
|
+
<td style="padding:15px">getADashboardList(apiKey, applicationKey, callback)</td>
|
|
425
|
+
<td style="padding:15px">### Overview
|
|
426
|
+
|
|
427
|
+
Fetch an existing dashboard list’s definition.
|
|
428
|
+
|
|
429
|
+
### Arguments
|
|
430
|
+
|
|
431
|
+
This end point takes no JSON arguments.</td>
|
|
432
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
433
|
+
<td style="padding:15px">Yes</td>
|
|
434
|
+
</tr>
|
|
435
|
+
<tr>
|
|
436
|
+
<td style="padding:15px">updateADashboardList(body, apiKey, applicationKey, callback)</td>
|
|
437
|
+
<td style="padding:15px">### Overview
|
|
438
|
+
|
|
439
|
+
Update the name of a dashboard list
|
|
440
|
+
|
|
441
|
+
### Arguments
|
|
442
|
+
|
|
443
|
+
* **`name`** [*required*]: The name of the dashboard list.</td>
|
|
444
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
445
|
+
<td style="padding:15px">Yes</td>
|
|
446
|
+
</tr>
|
|
447
|
+
<tr>
|
|
448
|
+
<td style="padding:15px">deleteADashboardList(apiKey, applicationKey, callback)</td>
|
|
449
|
+
<td style="padding:15px">### Overview
|
|
450
|
+
|
|
451
|
+
Delete an existing dashboard list.
|
|
452
|
+
|
|
453
|
+
### Arguments
|
|
454
|
+
|
|
455
|
+
This end point takes no JSON arguments.</td>
|
|
456
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
457
|
+
<td style="padding:15px">Yes</td>
|
|
458
|
+
</tr>
|
|
459
|
+
<tr>
|
|
460
|
+
<td style="padding:15px">getAllDashboardLists(apiKey, applicationKey, callback)</td>
|
|
461
|
+
<td style="padding:15px">### Overview
|
|
462
|
+
|
|
463
|
+
Fetch all of your existing dashboard list definitions.
|
|
464
|
+
|
|
465
|
+
### Arguments
|
|
466
|
+
|
|
467
|
+
This end point takes no JSON arguments.</td>
|
|
468
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
469
|
+
<td style="padding:15px">Yes</td>
|
|
470
|
+
</tr>
|
|
471
|
+
<tr>
|
|
472
|
+
<td style="padding:15px">createADashboardList(body, apiKey, applicationKey, callback)</td>
|
|
473
|
+
<td style="padding:15px">### Overview
|
|
474
|
+
|
|
475
|
+
Create an empty dashboard list.
|
|
476
|
+
|
|
477
|
+
### Arguments
|
|
478
|
+
|
|
479
|
+
* **`name`** [*required*]: The name of the dashboard list.</td>
|
|
480
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
481
|
+
<td style="padding:15px">Yes</td>
|
|
482
|
+
</tr>
|
|
483
|
+
<tr>
|
|
484
|
+
<td style="padding:15px">getItemsOfADashboardList(apiKey, applicationKey, callback)</td>
|
|
485
|
+
<td style="padding:15px">### Overview
|
|
486
|
+
|
|
487
|
+
Fetch the dashboard list’s dashboard definitions.
|
|
488
|
+
|
|
489
|
+
### Arguments
|
|
490
|
+
|
|
491
|
+
This end point takes no JSON arguments.</td>
|
|
492
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
493
|
+
<td style="padding:15px">Yes</td>
|
|
494
|
+
</tr>
|
|
495
|
+
<tr>
|
|
496
|
+
<td style="padding:15px">addItemsToDashboardList(body, apiKey, applicationKey, callback)</td>
|
|
497
|
+
<td style="padding:15px">### Overview
|
|
498
|
+
|
|
499
|
+
Add dashboards to an existing dashboard list.
|
|
500
|
+
|
|
501
|
+
### Arguments
|
|
502
|
+
|
|
503
|
+
* **`dashboards`** [*required*]: A list of dashboards to add to the list. Dashboard definitions follow this form:
|
|
504
|
+
* **`type`** [*required*]: The type of the dashboard. The type must be one of:
|
|
505
|
+
* `"custom_timeboard"`
|
|
506
|
+
* `"custom_screenboard"`
|
|
507
|
+
* `"integration_screenboard"`
|
|
508
|
+
* `"integration_timeboard"`
|
|
509
|
+
* `"host_timeboard"`
|
|
510
|
+
* **`id`** [*required*]: The id of the dashboard.</td>
|
|
511
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
512
|
+
<td style="padding:15px">Yes</td>
|
|
513
|
+
</tr>
|
|
514
|
+
<tr>
|
|
515
|
+
<td style="padding:15px">updateItemsOfADashboardList(body, apiKey, applicationKey, callback)</td>
|
|
516
|
+
<td style="padding:15px">### Overview
|
|
517
|
+
|
|
518
|
+
Update dashboards of an existing dashboard list.
|
|
519
|
+
|
|
520
|
+
### ARGUMENTS
|
|
521
|
+
|
|
522
|
+
* **`dashboards`** [*required*]: The new list of dashboards for the dashboard list. Dashboard definitions follow this form:
|
|
523
|
+
* **`type`** [*required*]: The type of the dashboard. The type must be one of:
|
|
524
|
+
* `"custom_timeboard"`
|
|
525
|
+
* `"custom_screenboard"`
|
|
526
|
+
* `"integration_screenboard"`
|
|
527
|
+
* `"integration_timeboard"`
|
|
528
|
+
* `"host_timeboard"`
|
|
529
|
+
* **`id`** [*required*]: The id of th...(description truncated)</td>
|
|
530
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
531
|
+
<td style="padding:15px">Yes</td>
|
|
532
|
+
</tr>
|
|
533
|
+
<tr>
|
|
534
|
+
<td style="padding:15px">deleteItemsFromADashboardList(apiKey, applicationKey, callback)</td>
|
|
535
|
+
<td style="padding:15px">### Overview
|
|
536
|
+
|
|
537
|
+
Delete dashboards from an existing dashboard list.
|
|
538
|
+
|
|
539
|
+
### Arguments
|
|
540
|
+
|
|
541
|
+
* **`dashboards`** [*required*]: A list of dashboards to remove from the list. Dashboard definitions follow this form:
|
|
542
|
+
* **`type`** [*required*]: The type of the dashboard. The type must be one of:
|
|
543
|
+
* `"custom_timeboard"`
|
|
544
|
+
* `"custom_screenboard"`
|
|
545
|
+
* `"integration_screenboard"`
|
|
546
|
+
* `"integration_timeboard"`
|
|
547
|
+
* `"host_timeboard"`
|
|
548
|
+
* **`id`** [*required*]: The id of the d...(description truncated)</td>
|
|
549
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
550
|
+
<td style="padding:15px">Yes</td>
|
|
551
|
+
</tr>
|
|
552
|
+
<tr>
|
|
553
|
+
<td style="padding:15px">scheduleMonitorDowntime(body, apiKey, applicationKey, callback)</td>
|
|
554
|
+
<td style="padding:15px">### Overview
|
|
555
|
+
|
|
556
|
+
Schedule a single Downtime.
|
|
557
|
+
|
|
558
|
+
### ARGUMENTS
|
|
559
|
+
|
|
560
|
+
* **`scope`** [*required*]: The scope(s) to which the downtime applies, e.g. `host:app2`. Provide multiple scopes as a comma-separated list, e.g. `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (i.e. `env:dev` **AND** `env:prod`), NOT any of them.
|
|
561
|
+
* **`monitor_tags`** [*optional*, *default*=**no monitor tag filter**]: A comma-separated list of monitor tags, i.e. tags that are applied directly...(description truncated)</td>
|
|
562
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
563
|
+
<td style="padding:15px">Yes</td>
|
|
564
|
+
</tr>
|
|
565
|
+
<tr>
|
|
566
|
+
<td style="padding:15px">getAllMointorDowntimes(apiKey, applicationKey, callback)</td>
|
|
567
|
+
<td style="padding:15px">### Overview
|
|
568
|
+
|
|
569
|
+
Get All Scheduled Downtimes
|
|
570
|
+
|
|
571
|
+
### ARGUMENTS
|
|
572
|
+
|
|
573
|
+
* **`current_only`** [*optional*, *default* = **False**]: Only return downtimes that are activewhen the request is made.</td>
|
|
574
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
575
|
+
<td style="padding:15px">Yes</td>
|
|
576
|
+
</tr>
|
|
577
|
+
<tr>
|
|
578
|
+
<td style="padding:15px">updateMonitorDowntime(body, apiKey, applicationKey, callback)</td>
|
|
579
|
+
<td style="padding:15px">### Overview
|
|
580
|
+
|
|
581
|
+
Update a single Downtime by downtime_id.
|
|
582
|
+
|
|
583
|
+
### Arguments
|
|
584
|
+
|
|
585
|
+
* **`id`** [*required*]: The integer id of the downtime to be updated
|
|
586
|
+
* **`scope`** [*required*]: The scope to which the downtime applies, e.g. 'host:app2'. Provide multiple scopes as a comma-separated list, e.g. 'env:dev,env:prod'. The resulting downtime applies to sources that matches ALL provided scopes (i.e. env:dev AND env:prod), NOT any of them.
|
|
587
|
+
* **`monitor_tags`** [*optional*, *default*=**no monitor tag filter**]: A c...(description truncated)</td>
|
|
588
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
589
|
+
<td style="padding:15px">Yes</td>
|
|
590
|
+
</tr>
|
|
591
|
+
<tr>
|
|
592
|
+
<td style="padding:15px">cancelMonitorDowntime(apiKey, applicationKey, callback)</td>
|
|
593
|
+
<td style="padding:15px">DELETE a Downtime Detail by downtime_id</td>
|
|
594
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
595
|
+
<td style="padding:15px">Yes</td>
|
|
596
|
+
</tr>
|
|
597
|
+
<tr>
|
|
598
|
+
<td style="padding:15px">getAMonitorDowntime(apiKey, applicationKey, callback)</td>
|
|
599
|
+
<td style="padding:15px">### Overview
|
|
600
|
+
|
|
601
|
+
Get Downtime Detail by downtime_id
|
|
602
|
+
|
|
603
|
+
### Arguments
|
|
604
|
+
|
|
605
|
+
This endpoint takes no JSON arguments.</td>
|
|
606
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
607
|
+
<td style="padding:15px">Yes</td>
|
|
608
|
+
</tr>
|
|
609
|
+
<tr>
|
|
610
|
+
<td style="padding:15px">cancelMonitorDowntimesByScope(body, apiKey, applicationKey, callback)</td>
|
|
611
|
+
<td style="padding:15px">### Overview
|
|
612
|
+
|
|
613
|
+
DELETE all Downtimes that match the scope of X
|
|
614
|
+
|
|
615
|
+
### Arguments
|
|
616
|
+
|
|
617
|
+
* **`scope`** [*required*]: Cancel all downtimes with the given scope(s), e.g.: `env:prod`, `role:db,role:db-slave`</td>
|
|
618
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
619
|
+
<td style="padding:15px">Yes</td>
|
|
620
|
+
</tr>
|
|
621
|
+
<tr>
|
|
622
|
+
<td style="padding:15px">getAllEmbeddableGraphs(apiKey, applicationKey, callback)</td>
|
|
623
|
+
<td style="padding:15px">### Overview
|
|
624
|
+
|
|
625
|
+
Gets a list of previously created embeddable graphs.
|
|
626
|
+
|
|
627
|
+
Returns: A JSON list containing information on previously created embeds from both the UI and the API. Each JSON graph response is in the same format as returned by GET `api/v1/graph/embed/ `.
|
|
628
|
+
|
|
629
|
+
### ARGUMENTS
|
|
630
|
+
|
|
631
|
+
This endpoint takes no JSON arguments.</td>
|
|
632
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
633
|
+
<td style="padding:15px">Yes</td>
|
|
634
|
+
</tr>
|
|
635
|
+
<tr>
|
|
636
|
+
<td style="padding:15px">createEmbedGraph(body, apiKey, applicationKey, callback)</td>
|
|
637
|
+
<td style="padding:15px">### Overview
|
|
638
|
+
|
|
639
|
+
Creates a new embeddable graph.
|
|
640
|
+
|
|
641
|
+
Returns: A JSON consisting of the same elements returned by GET `api/v1/graph/embed/ `. On failure, the return value is a JSON containing an error message {errors: [messages]}.
|
|
642
|
+
|
|
643
|
+
Note: If an embed already exists for the exact same query in a given organization, the older embed is returned instead of creating a new embed.
|
|
644
|
+
|
|
645
|
+
If you are interested in using template variables, see [Embeddable Graphs with Template Variables](https://docs.datadoghq.com/grap...(description truncated)</td>
|
|
646
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
647
|
+
<td style="padding:15px">Yes</td>
|
|
648
|
+
</tr>
|
|
649
|
+
<tr>
|
|
650
|
+
<td style="padding:15px">getASpecificEmbed(apiKey, applicationKey, callback)</td>
|
|
651
|
+
<td style="padding:15px">### Overview
|
|
652
|
+
|
|
653
|
+
Get the HTML fragment for a previously generated embed with embed_id.
|
|
654
|
+
|
|
655
|
+
Returns: A JSON object with 8 elements:
|
|
656
|
+
|
|
657
|
+
* `embed_id`: Token of the embed
|
|
658
|
+
* `graph_title`: Tile of the graph
|
|
659
|
+
* `dash_name`: Name of the dashboard the graph is on (null if none)
|
|
660
|
+
* `dash_url`: URL of the dashboard the graph is on (null if none)
|
|
661
|
+
* `shared_by`: ID of the use who shared the embed
|
|
662
|
+
* `html`: HTML fragment for the embed (iframe)
|
|
663
|
+
* `revoked`: Boolean flag for whther or not the embed is revoked
|
|
664
|
+
|
|
665
|
+
On failur...(description truncated)</td>
|
|
666
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
667
|
+
<td style="padding:15px">Yes</td>
|
|
668
|
+
</tr>
|
|
669
|
+
<tr>
|
|
670
|
+
<td style="padding:15px">enableEmbed(apiKey, applicationKey, callback)</td>
|
|
671
|
+
<td style="padding:15px">### Overview
|
|
672
|
+
|
|
673
|
+
Enable a specified embed.
|
|
674
|
+
|
|
675
|
+
Returns: A JSON containing the success message `{success: [message]}`. On failure, the return value is a JSON containing an error message `{errors: [messages]}`.
|
|
676
|
+
|
|
677
|
+
### Arguments
|
|
678
|
+
|
|
679
|
+
This endpoint takes no JSON arguments.</td>
|
|
680
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
681
|
+
<td style="padding:15px">Yes</td>
|
|
682
|
+
</tr>
|
|
683
|
+
<tr>
|
|
684
|
+
<td style="padding:15px">revokeEmbed(apiKey, applicationKey, callback)</td>
|
|
685
|
+
<td style="padding:15px">### Overview
|
|
686
|
+
|
|
687
|
+
Revoke a specified embed.
|
|
688
|
+
|
|
689
|
+
Returns: A JSON containing the success message `{success: [message]}`. On failure, the return value is a JSON containing an error message `{errors: [messages]}`.
|
|
690
|
+
|
|
691
|
+
### Arguments
|
|
692
|
+
|
|
693
|
+
This endpoint takes no JSON arguments.</td>
|
|
694
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
695
|
+
<td style="padding:15px">Yes</td>
|
|
696
|
+
</tr>
|
|
697
|
+
<tr>
|
|
698
|
+
<td style="padding:15px">postAnEvent(body, apiKey, applicationKey, callback)</td>
|
|
699
|
+
<td style="padding:15px">### Overview
|
|
700
|
+
|
|
701
|
+
This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.
|
|
702
|
+
|
|
703
|
+
### Arguments
|
|
704
|
+
|
|
705
|
+
* **`title`** [*required*]: The event title. *Limited to 100 characters.* Use `msg_title` with [the Datadog Ruby library](https://github.com/DataDog/dogapi-rb).
|
|
706
|
+
* **`text`** [*required*]: The body of the event. *Limited to 4000 characters.* The text supports [markdown](https://docs.datadoghq.com/graphing/event_stream/#markdown-events). Use `m...(description truncated)</td>
|
|
707
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
708
|
+
<td style="padding:15px">Yes</td>
|
|
709
|
+
</tr>
|
|
710
|
+
<tr>
|
|
711
|
+
<td style="padding:15px">queryTheEventStream(apiKey, applicationKey, callback)</td>
|
|
712
|
+
<td style="padding:15px">### Overview
|
|
713
|
+
|
|
714
|
+
The [event stream](https://docs.datadoghq.com/graphing/event_stream) can be queried and filtered by time, priority, sources and tags.
|
|
715
|
+
Note: if the event you're querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output
|
|
716
|
+
|
|
717
|
+
### Arguments
|
|
718
|
+
|
|
719
|
+
* **`start`** [*required*]: POSIX timestamp.
|
|
720
|
+
* **`end`** [*required*]: POSIX timestamp.
|
|
721
|
+
* **`priority`** [*optional*, *default*=**None**]: Priority of your events: **low** or **normal**.
|
|
722
|
+
* **`sources`** [*op...(description truncated)</td>
|
|
723
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
724
|
+
<td style="padding:15px">Yes</td>
|
|
725
|
+
</tr>
|
|
726
|
+
<tr>
|
|
727
|
+
<td style="padding:15px">getAnEvent(apiKey, applicationKey, callback)</td>
|
|
728
|
+
<td style="padding:15px">### Overview
|
|
729
|
+
|
|
730
|
+
Get event details by event_id
|
|
731
|
+
|
|
732
|
+
### Arguments
|
|
733
|
+
|
|
734
|
+
This endpoint takes no JSON arguments.</td>
|
|
735
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
736
|
+
<td style="padding:15px">Yes</td>
|
|
737
|
+
</tr>
|
|
738
|
+
<tr>
|
|
739
|
+
<td style="padding:15px">deleteAnEvent(apiKey, applicationKey, callback)</td>
|
|
740
|
+
<td style="padding:15px">### Overview
|
|
741
|
+
|
|
742
|
+
DELETE event details by event_id
|
|
743
|
+
|
|
744
|
+
### Arguments
|
|
745
|
+
|
|
746
|
+
This endpoint takes no JSON arguments.</td>
|
|
747
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
748
|
+
<td style="padding:15px">Yes</td>
|
|
749
|
+
</tr>
|
|
750
|
+
<tr>
|
|
751
|
+
<td style="padding:15px">graphASnapshot(apiKey, applicationKey, metricQuery, start, end, title, callback)</td>
|
|
752
|
+
<td style="padding:15px">### Overview
|
|
753
|
+
|
|
754
|
+
Get a Graph snapshot.
|
|
755
|
+
|
|
756
|
+
##### ARGUMENTS
|
|
757
|
+
|
|
758
|
+
* **`metric_query`** [*required*]: The metric query.
|
|
759
|
+
* **`start`** [*required*]: The POSIX timestamp of the start of the query.
|
|
760
|
+
* **`end`** [*required*]: The POSIX timestamp of the end of the query.
|
|
761
|
+
* **`event_query`** [*optional*, *default*=**None**]: A query that adds event bands to the graph.
|
|
762
|
+
* **`graph_def`** [*optional*, *default*=**None**]: A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON d...(description truncated)</td>
|
|
763
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
764
|
+
<td style="padding:15px">Yes</td>
|
|
765
|
+
</tr>
|
|
766
|
+
<tr>
|
|
767
|
+
<td style="padding:15px">searchHosts(apiKey, applicationKey, filter, sortField, sortDir, start, count, callback)</td>
|
|
768
|
+
<td style="padding:15px">### Overview
|
|
769
|
+
|
|
770
|
+
This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included. Results are paginated with a max of 100 results at a time.
|
|
771
|
+
|
|
772
|
+
### Arguments
|
|
773
|
+
|
|
774
|
+
* **`filter`** [*optional*, *default*=**None**]: Query string to filter search results.
|
|
775
|
+
* **`sort_field`** [*optional*, *default*=**cpu**]: Sort hosts by the given field. Options: **status**, **apps**, **cpu**, **iowait**, **load**
|
|
776
|
+
* **`sort_dir`** [*optional*, *default*=**desc**]: Direction of s...(description truncated)</td>
|
|
777
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
778
|
+
<td style="padding:15px">Yes</td>
|
|
779
|
+
</tr>
|
|
780
|
+
<tr>
|
|
781
|
+
<td style="padding:15px">hostTotals(apiKey, applicationKey, callback)</td>
|
|
782
|
+
<td style="padding:15px">### Overview
|
|
783
|
+
|
|
784
|
+
This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.
|
|
785
|
+
|
|
786
|
+
### ARGUMENTS
|
|
787
|
+
|
|
788
|
+
This endpoint takes no JSON arguments.</td>
|
|
789
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
790
|
+
<td style="padding:15px">Yes</td>
|
|
791
|
+
</tr>
|
|
792
|
+
<tr>
|
|
793
|
+
<td style="padding:15px">muteAHost(body, apiKey, applicationKey, callback)</td>
|
|
794
|
+
<td style="padding:15px">### Overview
|
|
795
|
+
|
|
796
|
+
Mute a host in order to avoid any monitor to trigger on it.
|
|
797
|
+
|
|
798
|
+
### Arguments
|
|
799
|
+
|
|
800
|
+
* **`end`** [*optional*, *default*=**None**]: POSIX timestamp when the host is unmuted. If omitted, the host remains muted until explicitly unmuted.
|
|
801
|
+
* **`message`** [*optional*, *default*=**None**]: Message to associate with the muting of this host.
|
|
802
|
+
* **`override`** [*optional*, *default*=**False**]: If true and the host is already muted, replaces existing host mute settings.</td>
|
|
803
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
804
|
+
<td style="padding:15px">Yes</td>
|
|
805
|
+
</tr>
|
|
806
|
+
<tr>
|
|
807
|
+
<td style="padding:15px">unmuteAHost(body, apiKey, applicationKey, callback)</td>
|
|
808
|
+
<td style="padding:15px">### Overview
|
|
809
|
+
|
|
810
|
+
Unmute a previously muted host
|
|
811
|
+
|
|
812
|
+
### Arguments
|
|
813
|
+
|
|
814
|
+
This endpoint takes no JSON arguments.</td>
|
|
815
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
816
|
+
<td style="padding:15px">Yes</td>
|
|
817
|
+
</tr>
|
|
818
|
+
<tr>
|
|
819
|
+
<td style="padding:15px">listAWSAccounts(apiKey, applicationKey, callback)</td>
|
|
820
|
+
<td style="padding:15px">### Overview
|
|
821
|
+
|
|
822
|
+
List all configured AWS accounts for Datadog.
|
|
823
|
+
|
|
824
|
+
### Arguments
|
|
825
|
+
|
|
826
|
+
This endpoint takes no JSON argument.</td>
|
|
827
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
828
|
+
<td style="padding:15px">Yes</td>
|
|
829
|
+
</tr>
|
|
830
|
+
<tr>
|
|
831
|
+
<td style="padding:15px">createAnAWSIntegration(body, apiKey, applicationKey, callback)</td>
|
|
832
|
+
<td style="padding:15px">### Overview
|
|
833
|
+
|
|
834
|
+
Create a Datadog-Amazon Web Services integration.
|
|
835
|
+
|
|
836
|
+
**Note**: Using the `POST` method updates your integration configuration by **adding** your new configuration to the existing one in your Datadog organization.
|
|
837
|
+
|
|
838
|
+
### Arguments
|
|
839
|
+
|
|
840
|
+
* **`account_id`** [*required*]:
|
|
841
|
+
|
|
842
|
+
Your AWS Account ID without dashes.
|
|
843
|
+
[Consult the Datadog AWS integration to learn more][1] about your AWS account ID.
|
|
844
|
+
|
|
845
|
+
* **`access_key_id`** [*optional*, *default*=**None**]:
|
|
846
|
+
|
|
847
|
+
If your AWS account is a GovCloud or ...(description truncated)</td>
|
|
848
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
849
|
+
<td style="padding:15px">Yes</td>
|
|
850
|
+
</tr>
|
|
851
|
+
<tr>
|
|
852
|
+
<td style="padding:15px">deleteAnAWSIntegration(apiKey, applicationKey, callback)</td>
|
|
853
|
+
<td style="padding:15px">### Overview
|
|
854
|
+
|
|
855
|
+
Delete your Datadog-AWS integration directly through Datadog API. [Read more about Datadog-AWS integration][1].
|
|
856
|
+
|
|
857
|
+
### Arguments
|
|
858
|
+
|
|
859
|
+
This endpoint takes no JSON argument.
|
|
860
|
+
|
|
861
|
+
[1]: https://docs.datadoghq.com/integrations/amazon_web_services</td>
|
|
862
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
863
|
+
<td style="padding:15px">Yes</td>
|
|
864
|
+
</tr>
|
|
865
|
+
<tr>
|
|
866
|
+
<td style="padding:15px">listAvailableNamespaceRules(apiKey, applicationKey, callback)</td>
|
|
867
|
+
<td style="padding:15px">### Overview
|
|
868
|
+
|
|
869
|
+
List available namespace rules for your AWS integration
|
|
870
|
+
|
|
871
|
+
### Arguments
|
|
872
|
+
|
|
873
|
+
This endpoint takes no JSON arguments</td>
|
|
874
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
875
|
+
<td style="padding:15px">Yes</td>
|
|
876
|
+
</tr>
|
|
877
|
+
<tr>
|
|
878
|
+
<td style="padding:15px">listAWSFilteringRules(apiKey, applicationKey, callback)</td>
|
|
879
|
+
<td style="padding:15px">### Overview
|
|
880
|
+
|
|
881
|
+
List AWS Accounts (role-based only) in Datadog.
|
|
882
|
+
|
|
883
|
+
### Arguments
|
|
884
|
+
|
|
885
|
+
This endpoint takes no JSON arguments.</td>
|
|
886
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
887
|
+
<td style="padding:15px">Yes</td>
|
|
888
|
+
</tr>
|
|
889
|
+
<tr>
|
|
890
|
+
<td style="padding:15px">configureAWSFilteringRuleCopy(body, apiKey, applicationKey, callback)</td>
|
|
891
|
+
<td style="padding:15px">### Overview
|
|
892
|
+
|
|
893
|
+
List AWS Accounts (role-based only) in Datadog. [Read more about Datadog-AWS integration][1].
|
|
894
|
+
|
|
895
|
+
### Arguments
|
|
896
|
+
|
|
897
|
+
* **`account_id`** [*required*]: Your AWS Account ID without dashes. [Consult the Datadog AWS integration to learn more][2] about your AWS account ID.
|
|
898
|
+
|
|
899
|
+
* **`access_key_id`** [*optional*, *default*=**None**]: If your AWS account is a GovCloud or China account, enter the corresponding Access Key ID.$
|
|
900
|
+
|
|
901
|
+
* **`namespace`** [*required*]: The AWS namespace to apply filtering too (e...(description truncated)</td>
|
|
902
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
903
|
+
<td style="padding:15px">Yes</td>
|
|
904
|
+
</tr>
|
|
905
|
+
<tr>
|
|
906
|
+
<td style="padding:15px">deleteAWSFilteringRule(apiKey, applicationKey, callback)</td>
|
|
907
|
+
<td style="padding:15px">Delete a Datadog-AWS Filtering rule</td>
|
|
908
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
909
|
+
<td style="padding:15px">Yes</td>
|
|
910
|
+
</tr>
|
|
911
|
+
<tr>
|
|
912
|
+
<td style="padding:15px">generateNewExternalIDs(body, apiKey, applicationKey, callback)</td>
|
|
913
|
+
<td style="padding:15px">### Overview
|
|
914
|
+
|
|
915
|
+
Generate a new AWS external id for a given AWS account id and role name pair.
|
|
916
|
+
|
|
917
|
+
### Arguments
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
* **`account_id`** [*required*]:
|
|
921
|
+
|
|
922
|
+
Your AWS Account ID without dashes.
|
|
923
|
+
[Consult the Datadog AWS integration to learn more][1] about your AWS account ID.
|
|
924
|
+
|
|
925
|
+
* **`role_name`** [*required*]:
|
|
926
|
+
|
|
927
|
+
Your Datadog role delegation name.
|
|
928
|
+
For more information about you AWS account Role name, [see the Datadog AWS integration configuration info][2].
|
|
929
|
+
|
|
930
|
+
[1]: /integrations/amazon_web_services/#co...(description truncated)</td>
|
|
931
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
932
|
+
<td style="padding:15px">Yes</td>
|
|
933
|
+
</tr>
|
|
934
|
+
<tr>
|
|
935
|
+
<td style="padding:15px">listAzureAccount(apiKey, applicationKey, callback)</td>
|
|
936
|
+
<td style="padding:15px">### Overview
|
|
937
|
+
|
|
938
|
+
List all Datadog-Azure integrations configured for your Datadog Account.
|
|
939
|
+
|
|
940
|
+
### Arguments
|
|
941
|
+
|
|
942
|
+
This endpoint takes no JSON argument.</td>
|
|
943
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
944
|
+
<td style="padding:15px">Yes</td>
|
|
945
|
+
</tr>
|
|
946
|
+
<tr>
|
|
947
|
+
<td style="padding:15px">updateAzureAccountSHostFilters(body, apiKey, applicationKey, callback)</td>
|
|
948
|
+
<td style="padding:15px">### Overview
|
|
949
|
+
|
|
950
|
+
Update Datadog-Azure host filtering.
|
|
951
|
+
|
|
952
|
+
### Arguments
|
|
953
|
+
|
|
954
|
+
Refer to the [Datadog-Azure integration installation instructions][1] to see how to obtain the following field values for your organization.
|
|
955
|
+
|
|
956
|
+
* **`tenant_name`** [*required*]: Your Azure Active Directory ID.
|
|
957
|
+
|
|
958
|
+
* **`client_id`** [*required*]: Your Azure web application ID.
|
|
959
|
+
|
|
960
|
+
* **`client_secret`** [*required*]: Your Azure web application secret key.
|
|
961
|
+
|
|
962
|
+
* **`host_filters`** [*optional*, *default*=**None**]: Limit the Azure instances th...(description truncated)</td>
|
|
963
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
964
|
+
<td style="padding:15px">Yes</td>
|
|
965
|
+
</tr>
|
|
966
|
+
<tr>
|
|
967
|
+
<td style="padding:15px">deleteAnAzureAccount(apiKey, applicationKey, callback)</td>
|
|
968
|
+
<td style="padding:15px">### Overview
|
|
969
|
+
|
|
970
|
+
Delete a Datadog-Azure integration.
|
|
971
|
+
|
|
972
|
+
### Arguments
|
|
973
|
+
|
|
974
|
+
This endpoint takes no JSON argument.</td>
|
|
975
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
976
|
+
<td style="padding:15px">Yes</td>
|
|
977
|
+
</tr>
|
|
978
|
+
<tr>
|
|
979
|
+
<td style="padding:15px">listGCPAccounts(apiKey, applicationKey, callback)</td>
|
|
980
|
+
<td style="padding:15px">### Overview
|
|
981
|
+
|
|
982
|
+
List all Datadog-GCP integrations configured for your Datadog Account.
|
|
983
|
+
|
|
984
|
+
### Arguments
|
|
985
|
+
|
|
986
|
+
This endpoint takes no JSON argument.</td>
|
|
987
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
988
|
+
<td style="padding:15px">Yes</td>
|
|
989
|
+
</tr>
|
|
990
|
+
<tr>
|
|
991
|
+
<td style="padding:15px">createGCPAccount(body, apiKey, applicationKey, callback)</td>
|
|
992
|
+
<td style="padding:15px">### Overview
|
|
993
|
+
|
|
994
|
+
Configure your Datadog-Google Cloud Platform integration directly through the Datadog API.
|
|
995
|
+
[Read more about Datadog-Google Cloud Platform integration][1].
|
|
996
|
+
|
|
997
|
+
**Note**: Using the `POST` method updates your integration configuration by **adding** your new configuration to the existing one in your Datadog organization.
|
|
998
|
+
|
|
999
|
+
### Arguments
|
|
1000
|
+
|
|
1001
|
+
All of the following fields' values are provided by the JSON service account key file created in the [GCP Console for service accounts][2]; Refer to t...(description truncated)</td>
|
|
1002
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1003
|
+
<td style="padding:15px">Yes</td>
|
|
1004
|
+
</tr>
|
|
1005
|
+
<tr>
|
|
1006
|
+
<td style="padding:15px">updateAGCPServiceAccountSAutomuteOption(body, apiKey, applicationKey, callback)</td>
|
|
1007
|
+
<td style="padding:15px">### Overview
|
|
1008
|
+
|
|
1009
|
+
Update your Datadog-Google Cloud Platform integration Automute options.
|
|
1010
|
+
[Read more about Datadog-Google Cloud Platform integration][1].
|
|
1011
|
+
|
|
1012
|
+
### Arguments
|
|
1013
|
+
|
|
1014
|
+
* **`project_id`** [*required*]: Your Google Cloud project ID found in your JSON service account key.
|
|
1015
|
+
|
|
1016
|
+
* **`client_email`** [*required*]: Your email found in your JSON service account key.
|
|
1017
|
+
|
|
1018
|
+
* **`automute`** [*optional*, *default*=**false**]: Silence monitors for expected GCE instance shutdowns.
|
|
1019
|
+
|
|
1020
|
+
[1]: https://docs.datadoghq.com/integ...(description truncated)</td>
|
|
1021
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1022
|
+
<td style="padding:15px">Yes</td>
|
|
1023
|
+
</tr>
|
|
1024
|
+
<tr>
|
|
1025
|
+
<td style="padding:15px">deleteAGCPServiceAccount(apiKey, applicationKey, callback)</td>
|
|
1026
|
+
<td style="padding:15px">### Overview
|
|
1027
|
+
|
|
1028
|
+
Delete the Datadog-Google Cloud Platform integration. [Read more about Datadog-Google Cloud Platform integration][1].
|
|
1029
|
+
|
|
1030
|
+
### Arguments
|
|
1031
|
+
|
|
1032
|
+
This endpoint takes no JSON argument.
|
|
1033
|
+
|
|
1034
|
+
[1]: https://docs.datadoghq.com/integrations/google_cloud_platform</td>
|
|
1035
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1036
|
+
<td style="padding:15px">Yes</td>
|
|
1037
|
+
</tr>
|
|
1038
|
+
<tr>
|
|
1039
|
+
<td style="padding:15px">getPagerDutyConfiguration(apiKey, applicationKey, callback)</td>
|
|
1040
|
+
<td style="padding:15px">### Overview
|
|
1041
|
+
|
|
1042
|
+
List all Datadog-PagerDuty integrations configured for your Datadog Account.
|
|
1043
|
+
|
|
1044
|
+
### Arguments
|
|
1045
|
+
|
|
1046
|
+
This endpoint takes no JSON argument.</td>
|
|
1047
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1048
|
+
<td style="padding:15px">Yes</td>
|
|
1049
|
+
</tr>
|
|
1050
|
+
<tr>
|
|
1051
|
+
<td style="padding:15px">addNewServicesAndSchedules(body, apiKey, applicationKey, callback)</td>
|
|
1052
|
+
<td style="padding:15px">### Overview
|
|
1053
|
+
|
|
1054
|
+
Add new services and schedules to your Datadog-PagerDuty integration. [Read more about Datadog-PagerDuty integration][1].
|
|
1055
|
+
|
|
1056
|
+
### Arguments
|
|
1057
|
+
|
|
1058
|
+
* **`services`** : Array of PagerDuty service objects. [Learn how to configure you Datadog service with PagerDuty documentation][2]. A PagerDuty service object is composed by:
|
|
1059
|
+
* **`service_name`** [*required*]: Your Service name in PagerDuty.
|
|
1060
|
+
* **`service_key`** [*required*]: Your Service name associated service key in Pagerduty.
|
|
1061
|
+
* **`schedu...(description truncated)</td>
|
|
1062
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1063
|
+
<td style="padding:15px">Yes</td>
|
|
1064
|
+
</tr>
|
|
1065
|
+
<tr>
|
|
1066
|
+
<td style="padding:15px">deletePagerDutyConfiguration(apiKey, applicationKey, callback)</td>
|
|
1067
|
+
<td style="padding:15px">### Overview
|
|
1068
|
+
|
|
1069
|
+
Delete a Datadog-PagerDuty integration configured in your Datadog Account. [Read more about Datadog-PagerDuty integration][1].
|
|
1070
|
+
|
|
1071
|
+
### Arguments
|
|
1072
|
+
|
|
1073
|
+
This endpoint takes no JSON arguments
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
[1]: https://docs.datadoghq.com/integrations/pagerduty</td>
|
|
1077
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1078
|
+
<td style="padding:15px">Yes</td>
|
|
1079
|
+
</tr>
|
|
1080
|
+
<tr>
|
|
1081
|
+
<td style="padding:15px">getSlackConfigurationDetails(apiKey, applicationKey, callback)</td>
|
|
1082
|
+
<td style="padding:15px">### Overview
|
|
1083
|
+
|
|
1084
|
+
List all Datadog-Slack integrations configured for your Datadog Account.
|
|
1085
|
+
|
|
1086
|
+
### Arguments
|
|
1087
|
+
|
|
1088
|
+
This endpoint takes no JSON argument.</td>
|
|
1089
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1090
|
+
<td style="padding:15px">Yes</td>
|
|
1091
|
+
</tr>
|
|
1092
|
+
<tr>
|
|
1093
|
+
<td style="padding:15px">addChannelsToExistingConfiguration(body, apiKey, applicationKey, callback)</td>
|
|
1094
|
+
<td style="padding:15px">### Overview
|
|
1095
|
+
|
|
1096
|
+
Add channels to your existing Datadog-Slack integration directly through Datadog API. [Read more about Datadog-Slack integration][1].
|
|
1097
|
+
|
|
1098
|
+
### Arguments
|
|
1099
|
+
|
|
1100
|
+
* **`channels`** [*required*]: Array of slack channel objects to post to. A slack channel object is composed by:
|
|
1101
|
+
|
|
1102
|
+
* **`channel_name`** [*required*]: Your channel name e.g: `#general`, `#private`
|
|
1103
|
+
|
|
1104
|
+
* **`transfer_all_user_comments`** [*optional*, *default*=**False**]: To be notified for every comment on a graph, set it to `true`....(description truncated)</td>
|
|
1105
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1106
|
+
<td style="padding:15px">Yes</td>
|
|
1107
|
+
</tr>
|
|
1108
|
+
<tr>
|
|
1109
|
+
<td style="padding:15px">deleteSlackConfigurationDetails(apiKey, applicationKey, callback)</td>
|
|
1110
|
+
<td style="padding:15px">### Overview
|
|
1111
|
+
|
|
1112
|
+
Delete a Datadog-Slack integration configured in your Datadog Account. [Read more about Datadog-Slack integration][1].
|
|
1113
|
+
|
|
1114
|
+
### Arguments
|
|
1115
|
+
|
|
1116
|
+
This endpoint takes no JSON arguments
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
[1]: https://docs.datadoghq.com/integrations/slack</td>
|
|
1120
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1121
|
+
<td style="padding:15px">Yes</td>
|
|
1122
|
+
</tr>
|
|
1123
|
+
<tr>
|
|
1124
|
+
<td style="padding:15px">getAllWebhookConfigurations(apiKey, applicationKey, callback)</td>
|
|
1125
|
+
<td style="padding:15px"></td>
|
|
1126
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1127
|
+
<td style="padding:15px">Yes</td>
|
|
1128
|
+
</tr>
|
|
1129
|
+
<tr>
|
|
1130
|
+
<td style="padding:15px">addToCurrentConfiguration(body, apiKey, applicationKey, callback)</td>
|
|
1131
|
+
<td style="padding:15px">ARGUMENTS</td>
|
|
1132
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1133
|
+
<td style="padding:15px">Yes</td>
|
|
1134
|
+
</tr>
|
|
1135
|
+
<tr>
|
|
1136
|
+
<td style="padding:15px">deleteWebhookConfigurations(apiKey, applicationKey, callback)</td>
|
|
1137
|
+
<td style="padding:15px"></td>
|
|
1138
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1139
|
+
<td style="padding:15px">Yes</td>
|
|
1140
|
+
</tr>
|
|
1141
|
+
<tr>
|
|
1142
|
+
<td style="padding:15px">replaceCurrentConfiguration(body, apiKey, applicationKey, callback)</td>
|
|
1143
|
+
<td style="padding:15px">ARGUMENTS</td>
|
|
1144
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1145
|
+
<td style="padding:15px">Yes</td>
|
|
1146
|
+
</tr>
|
|
1147
|
+
<tr>
|
|
1148
|
+
<td style="padding:15px">getAllAPIKey(apiKey, applicationKey, callback)</td>
|
|
1149
|
+
<td style="padding:15px">### Overview
|
|
1150
|
+
|
|
1151
|
+
Get all API keys available for your account.
|
|
1152
|
+
|
|
1153
|
+
### Arguments
|
|
1154
|
+
|
|
1155
|
+
This endpoint takes no JSON arguments.</td>
|
|
1156
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1157
|
+
<td style="padding:15px">Yes</td>
|
|
1158
|
+
</tr>
|
|
1159
|
+
<tr>
|
|
1160
|
+
<td style="padding:15px">createANewAPIKey(body, apiKey, applicationKey, callback)</td>
|
|
1161
|
+
<td style="padding:15px">### Overview
|
|
1162
|
+
|
|
1163
|
+
Create an API key with a given name.
|
|
1164
|
+
|
|
1165
|
+
### Arguments
|
|
1166
|
+
|
|
1167
|
+
* **`name`** [*required*]: Name of your API key.</td>
|
|
1168
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1169
|
+
<td style="padding:15px">Yes</td>
|
|
1170
|
+
</tr>
|
|
1171
|
+
<tr>
|
|
1172
|
+
<td style="padding:15px">getAGivenAPIKey(apiKey, applicationKey, callback)</td>
|
|
1173
|
+
<td style="padding:15px">### Overview
|
|
1174
|
+
|
|
1175
|
+
Get a given API key.
|
|
1176
|
+
|
|
1177
|
+
### Arguments
|
|
1178
|
+
|
|
1179
|
+
This endpoint takes no JSON arguments.</td>
|
|
1180
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1181
|
+
<td style="padding:15px">Yes</td>
|
|
1182
|
+
</tr>
|
|
1183
|
+
<tr>
|
|
1184
|
+
<td style="padding:15px">editAGivenAPIKey(body, apiKey, applicationKey, callback)</td>
|
|
1185
|
+
<td style="padding:15px">### Overview
|
|
1186
|
+
|
|
1187
|
+
Edit an API key name.
|
|
1188
|
+
|
|
1189
|
+
### Arguments
|
|
1190
|
+
|
|
1191
|
+
* **`name`** [*required*]: Name of your API key.</td>
|
|
1192
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1193
|
+
<td style="padding:15px">Yes</td>
|
|
1194
|
+
</tr>
|
|
1195
|
+
<tr>
|
|
1196
|
+
<td style="padding:15px">deleteAnAPIKey(apiKey, applicationKey, callback)</td>
|
|
1197
|
+
<td style="padding:15px">### Overview
|
|
1198
|
+
|
|
1199
|
+
Delete a given API key.
|
|
1200
|
+
|
|
1201
|
+
### Arguments
|
|
1202
|
+
|
|
1203
|
+
This endpoint takes no JSON arguments.</td>
|
|
1204
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1205
|
+
<td style="padding:15px">Yes</td>
|
|
1206
|
+
</tr>
|
|
1207
|
+
<tr>
|
|
1208
|
+
<td style="padding:15px">getAllApplicationKey(apiKey, applicationKey, callback)</td>
|
|
1209
|
+
<td style="padding:15px">### Overview
|
|
1210
|
+
|
|
1211
|
+
Get all application keys available for your account.
|
|
1212
|
+
|
|
1213
|
+
### Arguments
|
|
1214
|
+
|
|
1215
|
+
This endpoint takes no JSON arguments.</td>
|
|
1216
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1217
|
+
<td style="padding:15px">Yes</td>
|
|
1218
|
+
</tr>
|
|
1219
|
+
<tr>
|
|
1220
|
+
<td style="padding:15px">createANewApplicationKey(body, apiKey, applicationKey, callback)</td>
|
|
1221
|
+
<td style="padding:15px">### Overview
|
|
1222
|
+
|
|
1223
|
+
Create an application key with a given name.
|
|
1224
|
+
|
|
1225
|
+
### Arguments
|
|
1226
|
+
|
|
1227
|
+
* **`name`** [*required*]: Name of your application key.</td>
|
|
1228
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1229
|
+
<td style="padding:15px">Yes</td>
|
|
1230
|
+
</tr>
|
|
1231
|
+
<tr>
|
|
1232
|
+
<td style="padding:15px">getAGivenApplicationKey(apiKey, applicationKey, callback)</td>
|
|
1233
|
+
<td style="padding:15px">### Overview
|
|
1234
|
+
|
|
1235
|
+
Get a given application key.
|
|
1236
|
+
|
|
1237
|
+
### Arguments
|
|
1238
|
+
|
|
1239
|
+
This endpoint takes no JSON arguments.</td>
|
|
1240
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1241
|
+
<td style="padding:15px">Yes</td>
|
|
1242
|
+
</tr>
|
|
1243
|
+
<tr>
|
|
1244
|
+
<td style="padding:15px">editAGivenApplicationKey(body, apiKey, applicationKey, callback)</td>
|
|
1245
|
+
<td style="padding:15px">### Overview
|
|
1246
|
+
|
|
1247
|
+
Edit an application key name.
|
|
1248
|
+
|
|
1249
|
+
### Arguments
|
|
1250
|
+
|
|
1251
|
+
* **`name`** [*required*]: Name of your application key.</td>
|
|
1252
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1253
|
+
<td style="padding:15px">Yes</td>
|
|
1254
|
+
</tr>
|
|
1255
|
+
<tr>
|
|
1256
|
+
<td style="padding:15px">deleteAnApplicationKey(apiKey, applicationKey, callback)</td>
|
|
1257
|
+
<td style="padding:15px">### Overview
|
|
1258
|
+
|
|
1259
|
+
Delete a given application key.
|
|
1260
|
+
|
|
1261
|
+
### Arguments
|
|
1262
|
+
|
|
1263
|
+
This endpoint takes no JSON arguments.</td>
|
|
1264
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1265
|
+
<td style="padding:15px">Yes</td>
|
|
1266
|
+
</tr>
|
|
1267
|
+
<tr>
|
|
1268
|
+
<td style="padding:15px">sendLogsOverHTTP(body, ddsource, service, hostname, datadogApiKey, callback)</td>
|
|
1269
|
+
<td style="padding:15px">### Overview
|
|
1270
|
+
|
|
1271
|
+
Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:
|
|
1272
|
+
|
|
1273
|
+
* Maximum content size per payload: 2MB
|
|
1274
|
+
* Maximum size for a single log: 256kB
|
|
1275
|
+
* Maximum array size if sending multiple logs in an array: 50 entries
|
|
1276
|
+
|
|
1277
|
+
**Note**: If you are in the Datadog EU site (`app.datadoghq.eu`), the HTTP log endpoint is: `http-intake.logs.datadoghq.eu`.
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
### Arguments
|
|
1281
|
+
|
|
1282
|
+
| Item | Description ...(description truncated)</td>
|
|
1283
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1284
|
+
<td style="padding:15px">Yes</td>
|
|
1285
|
+
</tr>
|
|
1286
|
+
<tr>
|
|
1287
|
+
<td style="padding:15px">getAListOfLogs(body, apiKey, applicationKey, callback)</td>
|
|
1288
|
+
<td style="padding:15px">### Overview
|
|
1289
|
+
|
|
1290
|
+
List endpoint returns logs that match a log search query. Results are paginated.
|
|
1291
|
+
|
|
1292
|
+
### Arguments
|
|
1293
|
+
|
|
1294
|
+
* **`query`** [*required*]: The search query - following the [Log search syntax][1] .
|
|
1295
|
+
* **`time.from`** [*required*]: Minimum timestamp for requested logs. Format can be either
|
|
1296
|
+
- an ISO-8601 string
|
|
1297
|
+
- a unix timestamp (number representing the elapsed millisec since epoch)
|
|
1298
|
+
- a relative time (`now -10m`, `now - 1h`, `now - 1d`)
|
|
1299
|
+
* **`time.to`** [*required*]: Maximum timestamp fo...(description truncated)</td>
|
|
1300
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1301
|
+
<td style="padding:15px">Yes</td>
|
|
1302
|
+
</tr>
|
|
1303
|
+
<tr>
|
|
1304
|
+
<td style="padding:15px">getAllActiveMetrics(apiKey, applicationKey, from, host, callback)</td>
|
|
1305
|
+
<td style="padding:15px">### Overview
|
|
1306
|
+
|
|
1307
|
+
Get the list of actively reporting metrics from a given time until now. This endpoint is not available in the Python and Ruby libraries.
|
|
1308
|
+
|
|
1309
|
+
### Arguments
|
|
1310
|
+
|
|
1311
|
+
* **`from`** [*required*]: EPOCH timestamp from which to list metrics.
|
|
1312
|
+
* **`host`** [*optional*]: Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag.</td>
|
|
1313
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1314
|
+
<td style="padding:15px">Yes</td>
|
|
1315
|
+
</tr>
|
|
1316
|
+
<tr>
|
|
1317
|
+
<td style="padding:15px">sendTimeSeriesPoint(body, apiKey, applicationKey, callback)</td>
|
|
1318
|
+
<td style="padding:15px">### Overview
|
|
1319
|
+
|
|
1320
|
+
The metrics end-point allows you to post time-series data that can be graphed on Datadog's dashboards. The limit for compressed payloads is 3.2 megabytes (3200000), and 62 megabytes (62914560) for decompressed payloads.
|
|
1321
|
+
|
|
1322
|
+
### Arguments
|
|
1323
|
+
|
|
1324
|
+
* **`series`** [*required*]: Pass a JSON array where each item in the array contains the following arguments:
|
|
1325
|
+
|
|
1326
|
+
* **`metric`** [*required*]: The name of the timeseries
|
|
1327
|
+
* **`type`** [*optional*, *default*=**gauge**]: [Type][1] of your metric ei...(description truncated)</td>
|
|
1328
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1329
|
+
<td style="padding:15px">Yes</td>
|
|
1330
|
+
</tr>
|
|
1331
|
+
<tr>
|
|
1332
|
+
<td style="padding:15px">queryTimeSeriesPoints(apiKey, applicationKey, from, to, query, callback)</td>
|
|
1333
|
+
<td style="padding:15px">### Overview
|
|
1334
|
+
|
|
1335
|
+
This endpoint allows you to query for metrics from any time period.
|
|
1336
|
+
|
|
1337
|
+
### Arguments
|
|
1338
|
+
|
|
1339
|
+
* **`from`** [*required*]: EPOCH Timestamp from which to query metrics data.
|
|
1340
|
+
* **`to`** [*required*]: EPOCH Timestamp until which to query metrics data.
|
|
1341
|
+
* **`query`** [*required*]: The query string for the metric to retrieve. See [graphing documentation]() to learn how to build a metrics query.</td>
|
|
1342
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1343
|
+
<td style="padding:15px">Yes</td>
|
|
1344
|
+
</tr>
|
|
1345
|
+
<tr>
|
|
1346
|
+
<td style="padding:15px">viewMetricMetadata(apiKey, applicationKey, callback)</td>
|
|
1347
|
+
<td style="padding:15px">### Overview
|
|
1348
|
+
|
|
1349
|
+
The metrics metadata endpoint allows you to get metadata about a specific metric.
|
|
1350
|
+
|
|
1351
|
+
### Arguments
|
|
1352
|
+
|
|
1353
|
+
This endpoint takes no JSON arguments.</td>
|
|
1354
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1355
|
+
<td style="padding:15px">Yes</td>
|
|
1356
|
+
</tr>
|
|
1357
|
+
<tr>
|
|
1358
|
+
<td style="padding:15px">editMetricMetadata(body, apiKey, applicationKey, callback)</td>
|
|
1359
|
+
<td style="padding:15px">### Overview
|
|
1360
|
+
|
|
1361
|
+
The metrics metadata endpoint allows you to edit fields of a metric's metadata. [Find more about supported types][1]
|
|
1362
|
+
|
|
1363
|
+
### Arguments
|
|
1364
|
+
|
|
1365
|
+
* **`type`** [*required*]: [Metric type][1] such as **gauge** or **rate**
|
|
1366
|
+
* **`description`** [*optional*, *default*=**None**]: String description of the metric" default
|
|
1367
|
+
* **`short_name`** [*required*]: Short name string of the metric
|
|
1368
|
+
* **`unit`** [*optional*, *default*=**None**]: Primary unit of the metric such as **byte** or **operation**. [See the ...(description truncated)</td>
|
|
1369
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1370
|
+
<td style="padding:15px">Yes</td>
|
|
1371
|
+
</tr>
|
|
1372
|
+
<tr>
|
|
1373
|
+
<td style="padding:15px">searchMetrics(q, apiKey, applicationKey, callback)</td>
|
|
1374
|
+
<td style="padding:15px">### Overview
|
|
1375
|
+
|
|
1376
|
+
This endpoint allows you to search for metrics from the last 24 hours in Datadog.
|
|
1377
|
+
|
|
1378
|
+
### Arguments
|
|
1379
|
+
|
|
1380
|
+
* `q` [*required*]: The query string. Must be prefixed with `metrics:`.</td>
|
|
1381
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1382
|
+
<td style="padding:15px">Yes</td>
|
|
1383
|
+
</tr>
|
|
1384
|
+
<tr>
|
|
1385
|
+
<td style="padding:15px">createAMonitor(body, apiKey, applicationKey, callback)</td>
|
|
1386
|
+
<td style="padding:15px">### Overview
|
|
1387
|
+
|
|
1388
|
+
If you manage and deploy monitors programmatically, it's easier to define the monitor in the Datadog UI and [export its valid JSON][1].
|
|
1389
|
+
|
|
1390
|
+
### Arguments
|
|
1391
|
+
|
|
1392
|
+
* **`type`** [*required*]: The [type of the monitor][2], chosen from:
|
|
1393
|
+
|
|
1394
|
+
| Monitor Type | type attribute value |
|
|
1395
|
+
| :-------- | :------- |
|
|
1396
|
+
| anomaly | `query alert` |
|
|
1397
|
+
| apm | `query alert` |
|
|
1398
|
+
| composite | `composite` |
|
|
1399
|
+
| custom | `service check` |
|
|
1400
|
+
| event | `eve...(description truncated)</td>
|
|
1401
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1402
|
+
<td style="padding:15px">Yes</td>
|
|
1403
|
+
</tr>
|
|
1404
|
+
<tr>
|
|
1405
|
+
<td style="padding:15px">getAMonitorSDetails(apiKey, applicationKey, groupStates, callback)</td>
|
|
1406
|
+
<td style="padding:15px">### Overview
|
|
1407
|
+
|
|
1408
|
+
Get a monitor details based on its monitor ID.
|
|
1409
|
+
|
|
1410
|
+
### Arguments
|
|
1411
|
+
|
|
1412
|
+
* **`group_states`** [*optional*, *default*=**None**]: If this argument is set, the returned data includes additional information (if available) regarding the specified group states, including the last notification timestamp, last resolution timestamp and details about the last time the monitor was triggered. The argument should include a string list indicating what, if any, group states to include. Choose one or more f...(description truncated)</td>
|
|
1413
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1414
|
+
<td style="padding:15px">Yes</td>
|
|
1415
|
+
</tr>
|
|
1416
|
+
<tr>
|
|
1417
|
+
<td style="padding:15px">editAMonitorSDetails(body, apiKey, applicationKey, callback)</td>
|
|
1418
|
+
<td style="padding:15px">### Overview
|
|
1419
|
+
|
|
1420
|
+
Edit a monitor details based on its monitor ID.
|
|
1421
|
+
|
|
1422
|
+
### Arguments
|
|
1423
|
+
|
|
1424
|
+
* **`query`** [*required*]: The metric query to alert on.
|
|
1425
|
+
* **`name`** [*required*]: The name of the monitor.
|
|
1426
|
+
* **`message`** [*optional*, *default*=**dynamic, based on query**]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events.
|
|
1427
|
+
* **`options`** [*optional*, *default*=**{}**]: Refer to the create monitor documenta...(description truncated)</td>
|
|
1428
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1429
|
+
<td style="padding:15px">Yes</td>
|
|
1430
|
+
</tr>
|
|
1431
|
+
<tr>
|
|
1432
|
+
<td style="padding:15px">deleteAMonitor(apiKey, applicationKey, callback)</td>
|
|
1433
|
+
<td style="padding:15px">### Overview
|
|
1434
|
+
|
|
1435
|
+
Delete a monitor based on its monitor ID.
|
|
1436
|
+
|
|
1437
|
+
### Arguments
|
|
1438
|
+
|
|
1439
|
+
This endpoint takes no JSON arguments.</td>
|
|
1440
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1441
|
+
<td style="padding:15px">Yes</td>
|
|
1442
|
+
</tr>
|
|
1443
|
+
<tr>
|
|
1444
|
+
<td style="padding:15px">resolveMonitor(body, apiKey, applicationKey, callback)</td>
|
|
1445
|
+
<td style="padding:15px">### Overview
|
|
1446
|
+
|
|
1447
|
+
Resolve a monitor by monitorId & Group.
|
|
1448
|
+
|
|
1449
|
+
### Arguments
|
|
1450
|
+
|
|
1451
|
+
* **`resolve`** [*required*]: Array of group(s) to resolve for a given monitor_id, e.g.: `{"monitor_id": "group_to_resolve"}`
|
|
1452
|
+
|
|
1453
|
+
* It supports multiple groups per monitor, e.g.: `resolve: [{"monitor_id": "group_1"}, {"monitor_id": "group_2"}]`
|
|
1454
|
+
|
|
1455
|
+
* It can also resolve all triggered groups with the pseudo-group `ALL_GROUPS`: `resolve: [{"monitor_id": "ALL_GROUPS"}]`</td>
|
|
1456
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1457
|
+
<td style="padding:15px">Yes</td>
|
|
1458
|
+
</tr>
|
|
1459
|
+
<tr>
|
|
1460
|
+
<td style="padding:15px">muteASpecificMonitor(body, apiKey, applicationKey, callback)</td>
|
|
1461
|
+
<td style="padding:15px">### Overview
|
|
1462
|
+
|
|
1463
|
+
Mute a specific monitor base on its ID.
|
|
1464
|
+
|
|
1465
|
+
### Arguments
|
|
1466
|
+
* **`scope`** [*optional*, *default*=**None**]: The scope to apply the mute to, e.g. **role:db**. For example, if your alert is grouped by `{host}`, you might mute `host:app1`.
|
|
1467
|
+
* **`end`** [*optional*, *default*=**None**]: A POSIX timestamp for when the mute should end.</td>
|
|
1468
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1469
|
+
<td style="padding:15px">Yes</td>
|
|
1470
|
+
</tr>
|
|
1471
|
+
<tr>
|
|
1472
|
+
<td style="padding:15px">unmuteASpecificMonitor(body, apiKey, applicationKey, callback)</td>
|
|
1473
|
+
<td style="padding:15px">### Overview
|
|
1474
|
+
|
|
1475
|
+
### Arguments
|
|
1476
|
+
|
|
1477
|
+
* **`scope`** [*optional*, *default*=**None**]: The scope to apply the mute to. For example, if your alert is grouped by {host}, you might mute 'host:app1'
|
|
1478
|
+
* **`all_scopes`** [*optional*, *default* = **False**]: Clear muting across all scopes</td>
|
|
1479
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1480
|
+
<td style="padding:15px">Yes</td>
|
|
1481
|
+
</tr>
|
|
1482
|
+
<tr>
|
|
1483
|
+
<td style="padding:15px">muteAllMonitors(body, apiKey, applicationKey, callback)</td>
|
|
1484
|
+
<td style="padding:15px">### Overview
|
|
1485
|
+
|
|
1486
|
+
Muting prevents all monitors from notifying through email and posts to the [event stream][1]. State changes are only visible by checking the alert page.
|
|
1487
|
+
|
|
1488
|
+
### Arguments
|
|
1489
|
+
|
|
1490
|
+
This endpoint takes no JSON arguments.
|
|
1491
|
+
|
|
1492
|
+
[1]: https://docs.datadoghq.com/graphing/event_stream</td>
|
|
1493
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1494
|
+
<td style="padding:15px">Yes</td>
|
|
1495
|
+
</tr>
|
|
1496
|
+
<tr>
|
|
1497
|
+
<td style="padding:15px">unmuteAllMonitors(body, apiKey, applicationKey, callback)</td>
|
|
1498
|
+
<td style="padding:15px">### Overview
|
|
1499
|
+
|
|
1500
|
+
Disables muting all monitors. Throws an error if mute all was not enabled previously.
|
|
1501
|
+
|
|
1502
|
+
### Arguments
|
|
1503
|
+
|
|
1504
|
+
This endpoint takes no JSON arguments.</td>
|
|
1505
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1506
|
+
<td style="padding:15px">Yes</td>
|
|
1507
|
+
</tr>
|
|
1508
|
+
<tr>
|
|
1509
|
+
<td style="padding:15px">validateAMonitorDefinitions(body, apiKey, applicationKey, callback)</td>
|
|
1510
|
+
<td style="padding:15px">### Overview
|
|
1511
|
+
|
|
1512
|
+
Validates a monitor definition.
|
|
1513
|
+
|
|
1514
|
+
### Arguments
|
|
1515
|
+
|
|
1516
|
+
See [Create a monitor][1] documentation for details on constructing a monitor definition.
|
|
1517
|
+
|
|
1518
|
+
[1]: https://docs.datadoghq.com/api/#create-a-monitor</td>
|
|
1519
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1520
|
+
<td style="padding:15px">Yes</td>
|
|
1521
|
+
</tr>
|
|
1522
|
+
<tr>
|
|
1523
|
+
<td style="padding:15px">monitorSearch(apiKey, applicationKey, query, page, perPage, sort, callback)</td>
|
|
1524
|
+
<td style="padding:15px">### Overview
|
|
1525
|
+
|
|
1526
|
+
Search and filter your monitors details.
|
|
1527
|
+
|
|
1528
|
+
### Arguments
|
|
1529
|
+
|
|
1530
|
+
* **`query`** [*optional*]: After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query="type:metric status:alert"`.
|
|
1531
|
+
|
|
1532
|
+
* **`page`** [*optional*, *default* = **0**]: Page to star...(description truncated)</td>
|
|
1533
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1534
|
+
<td style="padding:15px">Yes</td>
|
|
1535
|
+
</tr>
|
|
1536
|
+
<tr>
|
|
1537
|
+
<td style="padding:15px">monitorGroupSearch(apiKey, applicationKey, query, page, perPage, sort, callback)</td>
|
|
1538
|
+
<td style="padding:15px">### Overview
|
|
1539
|
+
|
|
1540
|
+
Search and filter your monitor groups details.
|
|
1541
|
+
|
|
1542
|
+
### ARGUMENTS
|
|
1543
|
+
|
|
1544
|
+
* **`query`** [*optional*]: After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more.
|
|
1545
|
+
|
|
1546
|
+
* **`page`** [*optional*, *default* = **0**]: Page to start paginating from.
|
|
1547
|
+
|
|
1548
|
+
* **`per_page`** [*optional*, *default*=**30**]: Number of monitors to return per page.
|
|
1549
|
+
|
|
1550
|
+
* **`s...(description truncated)</td>
|
|
1551
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1552
|
+
<td style="padding:15px">Yes</td>
|
|
1553
|
+
</tr>
|
|
1554
|
+
<tr>
|
|
1555
|
+
<td style="padding:15px">createChildOrganization(body, apiKey, applicationKey, callback)</td>
|
|
1556
|
+
<td style="padding:15px">### Overview
|
|
1557
|
+
|
|
1558
|
+
This endpoint requires the [multi-org account][1] feature and must be enabled by [contacting support][2].
|
|
1559
|
+
|
|
1560
|
+
### Arguments
|
|
1561
|
+
|
|
1562
|
+
* **`name`** [*required*]: The name of the new child-organization, limited to 32 characters.
|
|
1563
|
+
* **`subscription`** [*required*]: A JSON array of subscription type. Types available are `trial`, `free`, and `pro`.
|
|
1564
|
+
* **`billing`** [*required*]: A JSON array of billing type. Note that only `parent_billing` is supported.
|
|
1565
|
+
|
|
1566
|
+
Once a new child-organization is created, you ...(description truncated)</td>
|
|
1567
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1568
|
+
<td style="padding:15px">Yes</td>
|
|
1569
|
+
</tr>
|
|
1570
|
+
<tr>
|
|
1571
|
+
<td style="padding:15px">getAllOrganizations(apiKey, applicationKey, callback)</td>
|
|
1572
|
+
<td style="padding:15px">### Overview
|
|
1573
|
+
|
|
1574
|
+
Get all child-organisation details for a given Master organisation.
|
|
1575
|
+
|
|
1576
|
+
### Arguments
|
|
1577
|
+
|
|
1578
|
+
This endpoint takes no JSON argument.</td>
|
|
1579
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1580
|
+
<td style="padding:15px">Yes</td>
|
|
1581
|
+
</tr>
|
|
1582
|
+
<tr>
|
|
1583
|
+
<td style="padding:15px">getOrganization(apiKey, applicationKey, callback)</td>
|
|
1584
|
+
<td style="padding:15px">### Overview
|
|
1585
|
+
Get an organisation details based on its public ID.
|
|
1586
|
+
|
|
1587
|
+
### Arguments
|
|
1588
|
+
|
|
1589
|
+
* **`public_id`** [*required*]: The public id of the organization.</td>
|
|
1590
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1591
|
+
<td style="padding:15px">Yes</td>
|
|
1592
|
+
</tr>
|
|
1593
|
+
<tr>
|
|
1594
|
+
<td style="padding:15px">updateOrganization(body, apiKey, applicationKey, callback)</td>
|
|
1595
|
+
<td style="padding:15px">### Overview
|
|
1596
|
+
|
|
1597
|
+
Update a Datadog organization information.
|
|
1598
|
+
|
|
1599
|
+
##### ARGUMENTS
|
|
1600
|
+
* **`name`** [*optional*]: The organization name.
|
|
1601
|
+
* **`settings`** [*optional*]: A JSON array of settings. Settings include:
|
|
1602
|
+
* **`saml`** - Set the boolean property `enabled` to enable or disable single sign on with SAML. See the [SAML documentation][1] for more information about all SAML settings.
|
|
1603
|
+
* **`saml_idp_initiated_login`** - has one property `enabled` (boolean).v
|
|
1604
|
+
* **`saml_strict_mode`** - has one prope...(description truncated)</td>
|
|
1605
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1606
|
+
<td style="padding:15px">Yes</td>
|
|
1607
|
+
</tr>
|
|
1608
|
+
<tr>
|
|
1609
|
+
<td style="padding:15px">uploadIDPMetadata(body, apiKey, applicationKey, callback)</td>
|
|
1610
|
+
<td style="padding:15px">### Overview
|
|
1611
|
+
|
|
1612
|
+
There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP.
|
|
1613
|
+
|
|
1614
|
+
* **Multipart Form-Data**: Post the IdP metadata file using a form post.
|
|
1615
|
+
* **XML Body**: Post the IdP metadata file as the body of the request.
|
|
1616
|
+
|
|
1617
|
+
### Multipart Form-Data
|
|
1618
|
+
|
|
1619
|
+
#### Headers
|
|
1620
|
+
|
|
1621
|
+
* **`Content-Type: multipart/form-data`**
|
|
1622
|
+
|
|
1623
|
+
#### Arguments
|
|
1624
|
+
|
|
1625
|
+
* **`idp_file`** [*required*]: The path to the XML metadata file you wish to upload.
|
|
1626
|
+
|
|
1627
|
+
### XML Body
|
|
1628
|
+
|
|
1629
|
+
#### Headers
|
|
1630
|
+
* **`Content-Type: applicatio...(description truncated)</td>
|
|
1631
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1632
|
+
<td style="padding:15px">Yes</td>
|
|
1633
|
+
</tr>
|
|
1634
|
+
<tr>
|
|
1635
|
+
<td style="padding:15px">createATest(body, apiKey, applicationKey, callback)</td>
|
|
1636
|
+
<td style="padding:15px">### Overview
|
|
1637
|
+
|
|
1638
|
+
Create a Synthetics test to initiate and configure the tests you want Datadog to send to your API endpoints or to your browser app. You can configure the endpoints being tested, the number of tests, and where they are coming from. The parameters required are different for API and browser tests and they are marked accordingly—if a parameter is marked as _required_, it is required for both types of tests. Once you create a test, it shows up in the UI in your [Synthetics list][1]
|
|
1639
|
+
|
|
1640
|
+
A b...(description truncated)</td>
|
|
1641
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1642
|
+
<td style="padding:15px">Yes</td>
|
|
1643
|
+
</tr>
|
|
1644
|
+
<tr>
|
|
1645
|
+
<td style="padding:15px">getAllTests(apiKey, applicationKey, callback)</td>
|
|
1646
|
+
<td style="padding:15px">### Overview
|
|
1647
|
+
|
|
1648
|
+
Get a list of all existing tests.
|
|
1649
|
+
|
|
1650
|
+
### Arguments
|
|
1651
|
+
|
|
1652
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1653
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1654
|
+
<td style="padding:15px">Yes</td>
|
|
1655
|
+
</tr>
|
|
1656
|
+
<tr>
|
|
1657
|
+
<td style="padding:15px">startOrPauseATest(body, apiKey, applicationKey, callback)</td>
|
|
1658
|
+
<td style="padding:15px">### Overview
|
|
1659
|
+
|
|
1660
|
+
Start or pause an existing Synthetics test.
|
|
1661
|
+
|
|
1662
|
+
##### Arguments
|
|
1663
|
+
|
|
1664
|
+
* **`new_status`** - _required_ - A key-value pair where you define whether you want to start or pause a test. Valid values are `live` and `paused`. Returns `true` if the status has been changed, and `false` if the status has stayed the same.</td>
|
|
1665
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1666
|
+
<td style="padding:15px">Yes</td>
|
|
1667
|
+
</tr>
|
|
1668
|
+
<tr>
|
|
1669
|
+
<td style="padding:15px">editATest(body, apiKey, applicationKey, callback)</td>
|
|
1670
|
+
<td style="padding:15px">### Overview
|
|
1671
|
+
|
|
1672
|
+
Use this method to update an existing Synthetics test. In order to update a test, you have to submit the same payload as creating a test.
|
|
1673
|
+
|
|
1674
|
+
The parameters required are different for API and browser tests and they are marked accordingly—if a parameter is marked as _required_, it is required for both types of tests.
|
|
1675
|
+
|
|
1676
|
+
A browser test is treated like a GET API test. This method gives you the ability to update the browser test, but you have to use the UI to [record your test][1].
|
|
1677
|
+
|
|
1678
|
+
In orde...(description truncated)</td>
|
|
1679
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1680
|
+
<td style="padding:15px">Yes</td>
|
|
1681
|
+
</tr>
|
|
1682
|
+
<tr>
|
|
1683
|
+
<td style="padding:15px">deleteATest(body, apiKey, applicationKey, callback)</td>
|
|
1684
|
+
<td style="padding:15px">### Overview
|
|
1685
|
+
|
|
1686
|
+
Delete one or many tests.
|
|
1687
|
+
|
|
1688
|
+
### Arguments
|
|
1689
|
+
|
|
1690
|
+
* **`public_ids`** - _required_ - A JSON list of the ID or IDs of the tests that you want to delete.</td>
|
|
1691
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1692
|
+
<td style="padding:15px">Yes</td>
|
|
1693
|
+
</tr>
|
|
1694
|
+
<tr>
|
|
1695
|
+
<td style="padding:15px">getAllTestResults(apiKey, applicationKey, callback)</td>
|
|
1696
|
+
<td style="padding:15px">### Overview
|
|
1697
|
+
|
|
1698
|
+
Get the most recent results for a specific test.
|
|
1699
|
+
|
|
1700
|
+
### Arguments
|
|
1701
|
+
|
|
1702
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1703
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1704
|
+
<td style="padding:15px">Yes</td>
|
|
1705
|
+
</tr>
|
|
1706
|
+
<tr>
|
|
1707
|
+
<td style="padding:15px">getASpecificTestResult(apiKey, applicationKey, callback)</td>
|
|
1708
|
+
<td style="padding:15px">### Overview
|
|
1709
|
+
|
|
1710
|
+
Get a specific result for a specific test.
|
|
1711
|
+
|
|
1712
|
+
### Arguments
|
|
1713
|
+
|
|
1714
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1715
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1716
|
+
<td style="padding:15px">Yes</td>
|
|
1717
|
+
</tr>
|
|
1718
|
+
<tr>
|
|
1719
|
+
<td style="padding:15px">getATest(apiKey, applicationKey, callback)</td>
|
|
1720
|
+
<td style="padding:15px">### Overview
|
|
1721
|
+
|
|
1722
|
+
Get information on a specific test.
|
|
1723
|
+
|
|
1724
|
+
### Arguments
|
|
1725
|
+
|
|
1726
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1727
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1728
|
+
<td style="padding:15px">Yes</td>
|
|
1729
|
+
</tr>
|
|
1730
|
+
<tr>
|
|
1731
|
+
<td style="padding:15px">getDevicesForBrowserChecks(apiKey, applicationKey, callback)</td>
|
|
1732
|
+
<td style="padding:15px">### Overview
|
|
1733
|
+
|
|
1734
|
+
Get a list of devices for browser checks.
|
|
1735
|
+
|
|
1736
|
+
### Arguments
|
|
1737
|
+
|
|
1738
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1739
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1740
|
+
<td style="padding:15px">Yes</td>
|
|
1741
|
+
</tr>
|
|
1742
|
+
<tr>
|
|
1743
|
+
<td style="padding:15px">getAvailableLocations(apiKey, applicationKey, callback)</td>
|
|
1744
|
+
<td style="padding:15px">### Overview
|
|
1745
|
+
|
|
1746
|
+
Get a list of available locations
|
|
1747
|
+
|
|
1748
|
+
### Arguments
|
|
1749
|
+
|
|
1750
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1751
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1752
|
+
<td style="padding:15px">Yes</td>
|
|
1753
|
+
</tr>
|
|
1754
|
+
<tr>
|
|
1755
|
+
<td style="padding:15px">getTags(apiKey, applicationKey, callback)</td>
|
|
1756
|
+
<td style="padding:15px">### Overview
|
|
1757
|
+
|
|
1758
|
+
Return a mapping of tags to hosts for your whole infrastructure.
|
|
1759
|
+
|
|
1760
|
+
### Arguments
|
|
1761
|
+
|
|
1762
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1763
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1764
|
+
<td style="padding:15px">Yes</td>
|
|
1765
|
+
</tr>
|
|
1766
|
+
<tr>
|
|
1767
|
+
<td style="padding:15px">getHostTags(apiKey, applicationKey, callback)</td>
|
|
1768
|
+
<td style="padding:15px">### Overview
|
|
1769
|
+
|
|
1770
|
+
Return the list of tags that apply to a given host.
|
|
1771
|
+
|
|
1772
|
+
### Arguments
|
|
1773
|
+
|
|
1774
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1775
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1776
|
+
<td style="padding:15px">Yes</td>
|
|
1777
|
+
</tr>
|
|
1778
|
+
<tr>
|
|
1779
|
+
<td style="padding:15px">addTagsToAHost(body, apiKey, applicationKey, callback)</td>
|
|
1780
|
+
<td style="padding:15px">### Overview
|
|
1781
|
+
|
|
1782
|
+
This endpoint allows you to add new tags to a host, optionally specifying where these tags come from.
|
|
1783
|
+
|
|
1784
|
+
### Arguments
|
|
1785
|
+
|
|
1786
|
+
* **`tags`** [*required*]: A list of tags to apply to the host
|
|
1787
|
+
* **`source`** [*optional*, *default*=**users**]: The source of the tags (e.g. chef, puppet). [Complete list of source attribute values][1]
|
|
1788
|
+
|
|
1789
|
+
[1]: https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value</td>
|
|
1790
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1791
|
+
<td style="padding:15px">Yes</td>
|
|
1792
|
+
</tr>
|
|
1793
|
+
<tr>
|
|
1794
|
+
<td style="padding:15px">updateHostTags(body, apiKey, applicationKey, callback)</td>
|
|
1795
|
+
<td style="padding:15px">### Overview
|
|
1796
|
+
|
|
1797
|
+
This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.
|
|
1798
|
+
|
|
1799
|
+
### Arguments
|
|
1800
|
+
|
|
1801
|
+
* **`tags`** [*required*]: A list of tags
|
|
1802
|
+
* **`source`** [*optional*, *default*=**users**]: The source of the tags (e.g. chef, puppet). [Complete list of source attribute values][1]
|
|
1803
|
+
|
|
1804
|
+
[1]: https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value</td>
|
|
1805
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1806
|
+
<td style="padding:15px">Yes</td>
|
|
1807
|
+
</tr>
|
|
1808
|
+
<tr>
|
|
1809
|
+
<td style="padding:15px">removeHostTags(apiKey, applicationKey, callback)</td>
|
|
1810
|
+
<td style="padding:15px">### Overview
|
|
1811
|
+
|
|
1812
|
+
Remove all tags in an integration source for a single host.
|
|
1813
|
+
|
|
1814
|
+
### Arguments
|
|
1815
|
+
|
|
1816
|
+
*This endpoint takes no JSON arguments.*</td>
|
|
1817
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1818
|
+
<td style="padding:15px">Yes</td>
|
|
1819
|
+
</tr>
|
|
1820
|
+
<tr>
|
|
1821
|
+
<td style="padding:15px">sendTraces(body, callback)</td>
|
|
1822
|
+
<td style="padding:15px">### Overview
|
|
1823
|
+
|
|
1824
|
+
Datadog's APM allows you to collect performance metrics by tracing your code to determine which parts of your application are slow or inefficient.
|
|
1825
|
+
|
|
1826
|
+
Tracing data is sent to the Datadog Agent via an HTTP API. We provide some [official libraries][1] that simplify sending metrics to the Datadog Agent, however you may want to interact directly with the API to instrument applications that cannot use the libraries or are written in languages that don't yet have an official Datadog Tracing...(description truncated)</td>
|
|
1827
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1828
|
+
<td style="padding:15px">Yes</td>
|
|
1829
|
+
</tr>
|
|
1830
|
+
<tr>
|
|
1831
|
+
<td style="padding:15px">sendServices(body, callback)</td>
|
|
1832
|
+
<td style="padding:15px">https://docs.datadoghq.com/api/?lang=bash#send-traces</td>
|
|
1833
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1834
|
+
<td style="padding:15px">Yes</td>
|
|
1835
|
+
</tr>
|
|
1836
|
+
<tr>
|
|
1837
|
+
<td style="padding:15px">getHostsAndContainersHourlyUsage(apiKey, applicationKey, startHr, endHr, callback)</td>
|
|
1838
|
+
<td style="padding:15px">### Overview
|
|
1839
|
+
|
|
1840
|
+
Get Hourly Usage For Hosts and Containers.
|
|
1841
|
+
|
|
1842
|
+
### Arguments
|
|
1843
|
+
|
|
1844
|
+
* **`start_hr`** [*required*]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour
|
|
1845
|
+
* **`end_hr`** [*optional*, *default*=**1d+start_hr**]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending BEFORE this hour
|
|
1846
|
+
|
|
1847
|
+
#### Response
|
|
1848
|
+
|
|
1849
|
+
* **`container_count`**: Shows the total number of containers reporting via the Docker integration during the hour.
|
|
1850
|
+
* **`ho...(description truncated)</td>
|
|
1851
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1852
|
+
<td style="padding:15px">Yes</td>
|
|
1853
|
+
</tr>
|
|
1854
|
+
<tr>
|
|
1855
|
+
<td style="padding:15px">getLogsHourlyUsage(apiKey, applicationKey, startHr, endHr, callback)</td>
|
|
1856
|
+
<td style="padding:15px">### Overview
|
|
1857
|
+
|
|
1858
|
+
Get Hourly Usage For Logs.
|
|
1859
|
+
|
|
1860
|
+
### Arguments
|
|
1861
|
+
* **`start_hr`** [*required*]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour
|
|
1862
|
+
* **`end_hr`** [*optional*, *default*=**1d+start_hr**]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending BEFORE this hour
|
|
1863
|
+
|
|
1864
|
+
#### Response
|
|
1865
|
+
|
|
1866
|
+
* **`ingested_events_bytes`**: Contains the number of log bytes ingested.
|
|
1867
|
+
* **`indexed_events_count`**: Contains the number of log events in...(description truncated)</td>
|
|
1868
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1869
|
+
<td style="padding:15px">Yes</td>
|
|
1870
|
+
</tr>
|
|
1871
|
+
<tr>
|
|
1872
|
+
<td style="padding:15px">getCustomMetricsHourlyUsage(apiKey, applicationKey, startHr, endHr, callback)</td>
|
|
1873
|
+
<td style="padding:15px">### Overview
|
|
1874
|
+
|
|
1875
|
+
Get Hourly Usage For [Custom Metrics][1].
|
|
1876
|
+
|
|
1877
|
+
### Arguments
|
|
1878
|
+
|
|
1879
|
+
* **`start_hr`** [*required*]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour
|
|
1880
|
+
* **`end_hr`** [*optional*, *default*=**1d+start_hr**]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending BEFORE this hour
|
|
1881
|
+
|
|
1882
|
+
[1]: https://docs.datadoghq.com/developers/metrics/custom_metrics</td>
|
|
1883
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1884
|
+
<td style="padding:15px">Yes</td>
|
|
1885
|
+
</tr>
|
|
1886
|
+
<tr>
|
|
1887
|
+
<td style="padding:15px">getTop500CustomMetricsByHourlyAverage(apiKey, applicationKey, month, names, callback)</td>
|
|
1888
|
+
<td style="padding:15px">### Overview
|
|
1889
|
+
|
|
1890
|
+
Get Top [Custom Metrics][1] By Hourly Average.
|
|
1891
|
+
|
|
1892
|
+
### Arguments
|
|
1893
|
+
* **`month`** [*required*]: Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour.
|
|
1894
|
+
* **`names`** [*optional*, *default*=**None**]: Comma-separated list of metric names.
|
|
1895
|
+
|
|
1896
|
+
[1]: https://docs.datadoghq.com/developers/metrics/custom_metrics</td>
|
|
1897
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1898
|
+
<td style="padding:15px">Yes</td>
|
|
1899
|
+
</tr>
|
|
1900
|
+
<tr>
|
|
1901
|
+
<td style="padding:15px">getMultiOrgUsageDetails(apiKey, applicationKey, startMonth, endMonth, includeOrgIds, callback)</td>
|
|
1902
|
+
<td style="padding:15px">### Overview
|
|
1903
|
+
|
|
1904
|
+
Get usage across your multi-org account
|
|
1905
|
+
|
|
1906
|
+
### Arguments
|
|
1907
|
+
|
|
1908
|
+
* **`start_month`** [*required*]: Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning in this month. Maximum of 15 months ago.
|
|
1909
|
+
* **`end_month`** [*optional*, *default*=**current_month-3d**]: Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage ending this month.
|
|
1910
|
+
* **`include_org_details`** [*optional*, *default*=**true**]: Include usage summaries for each sub-org.</td>
|
|
1911
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1912
|
+
<td style="padding:15px">Yes</td>
|
|
1913
|
+
</tr>
|
|
1914
|
+
<tr>
|
|
1915
|
+
<td style="padding:15px">getTraceSearchHourlyUsage(apiKey, applicationKey, startHr, endHr, callback)</td>
|
|
1916
|
+
<td style="padding:15px">### Overview
|
|
1917
|
+
|
|
1918
|
+
Get hourly usage For Trace Search.
|
|
1919
|
+
|
|
1920
|
+
### Arguments
|
|
1921
|
+
* **`start_hr`** [*required*]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour
|
|
1922
|
+
* **`end_hr`** [*optional*, *default*=**1d+start_hr**]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending BEFORE this hour
|
|
1923
|
+
|
|
1924
|
+
#### Response
|
|
1925
|
+
|
|
1926
|
+
* **`indexed_events_count`**: Contains the number of Trace Search events indexed.
|
|
1927
|
+
* **`hour`**: The hour for the usage.</td>
|
|
1928
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1929
|
+
<td style="padding:15px">Yes</td>
|
|
1930
|
+
</tr>
|
|
1931
|
+
<tr>
|
|
1932
|
+
<td style="padding:15px">getFargateHourlyUsage(apiKey, applicationKey, startHr, endHr, callback)</td>
|
|
1933
|
+
<td style="padding:15px">### Overview
|
|
1934
|
+
|
|
1935
|
+
Get Hourly Usage For [Fargate][1].
|
|
1936
|
+
|
|
1937
|
+
### Arguments
|
|
1938
|
+
|
|
1939
|
+
* **`start_hr`** [*required*]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour
|
|
1940
|
+
* **`end_hr`** [*optional*, *default*=**1d+start_hr**]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending BEFORE this hour
|
|
1941
|
+
|
|
1942
|
+
[1]: https://docs.datadoghq.com/integrations/ecs_fargate</td>
|
|
1943
|
+
<td style="padding:15px">{base_path}/{version}?{query}</td>
|
|
1944
|
+
<td style="padding:15px">Yes</td>
|
|
1945
|
+
</tr>
|
|
168
1946
|
</table>
|
|
169
1947
|
<br>
|