@@ -240,6 +240,83 @@ paths:
240
240
application/json :
241
241
schema :
242
242
$ref : ' #/components/schemas/Error'
243
+ /ping :
244
+ get :
245
+ description : |
246
+ Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
247
+
248
+ The response is a HTTP `204` status code to inform you the querier is available.
249
+
250
+ For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
251
+
252
+ To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
253
+
254
+ This endpoint doesn't require authentication.
255
+ operationId : GetPing
256
+ responses :
257
+ ' 204 ' :
258
+ description : |
259
+ Success--the querier is available.
260
+ Headers contain InfluxDB version information.
261
+ headers :
262
+ X-Influxdb-Build :
263
+ description : |
264
+ The type of InfluxDB build.
265
+ schema :
266
+ type : string
267
+ X-Influxdb-Version :
268
+ description : |
269
+ The version of InfluxDB.
270
+ schema :
271
+ type : integer
272
+ 4xx :
273
+ description : |
274
+ #### InfluxDB Cloud
275
+ - Doesn't return this error.
276
+ security :
277
+ - {}
278
+ servers : []
279
+ summary : Get the status of the instance
280
+ tags :
281
+ - Ping
282
+ head :
283
+ description : |
284
+ Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
285
+
286
+ The response is a HTTP `204` status code to inform you the querier is available.
287
+
288
+ For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
289
+
290
+ To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
291
+
292
+ This endpoint doesn't require authentication.
293
+
294
+ operationId : HeadPing
295
+ responses :
296
+ ' 204 ' :
297
+ description : |
298
+ Success--the querier is available.
299
+ Headers contain InfluxDB version information.
300
+ headers :
301
+ X-Influxdb-Build :
302
+ description : The type of InfluxDB build.
303
+ schema :
304
+ type : string
305
+ X-Influxdb-Version :
306
+ description : |
307
+ The version of InfluxDB.
308
+ schema :
309
+ type : integer
310
+ 4xx :
311
+ description : |
312
+ #### InfluxDB Cloud
313
+ - Doesn't return this error.
314
+ security :
315
+ - {}
316
+ servers : []
317
+ summary : Get the status of the instance
318
+ tags :
319
+ - Ping
243
320
components :
244
321
parameters :
245
322
TraceSpan :
0 commit comments