Ping API
Ping API documentation for JavaScript SDK
The default url is http://localhost:8080
| Method | HTTP request | Description |
|---|---|---|
| pingOnce | POST /v1/ping:once | Run a single ping probe |
| pingStream | POST /v1/ping:stream | Stream ping probe results |
pingOnce
PingResult pingOnce(pingOnceRequest)
Run a single ping probe
Runs a single ping probe and returns the probe result.
Example
import GoodMemClient from '@pairsystems/goodmem-client';
let apiInstance = new GoodMemClient.PingApi();
let pingOnceRequest = new GoodMemClient.PingOnceRequest(); // PingOnceRequest | Single ping probe request
apiInstance.pingOnce(pingOnceRequest).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pingOnceRequest | PingOnceRequest | Single ping probe request |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
pingStream
PingEvent pingStream(pingStreamRequest, opts)
Stream ping probe results
Opens a streaming ping session and returns per-probe results plus a terminal summary. Supports SSE (text/event-stream) and NDJSON (application/x-ndjson) formats.
Example
import GoodMemClient from '@pairsystems/goodmem-client';
let apiInstance = new GoodMemClient.PingApi();
let pingStreamRequest = new GoodMemClient.PingStreamRequest(); // PingStreamRequest | Ping stream configuration
let opts = {
'accept': "application/x-ndjson" // String | Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
};
apiInstance.pingStream(pingStreamRequest, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pingStreamRequest | PingStreamRequest | Ping stream configuration | |
| accept | String | Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON | [optional] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/x-ndjson, text/event-stream