Ping the server | swsh Public API documentation

Ping the server

GET /ping

Responses

200 application/json

Server is alive
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  message string Required
  
  callerId string Required
- warnings array[string]

GET /ping

curl \
 --request GET 'https://public-api.joinswsh.com/ping' \
 --header "x-api-key: $API_KEY"

Response examples (200)

{
  "data": {
    "message": "Pong!",
    "callerId": "11111111-1111-1111-1111-111111111111"
  },
  "warnings": [
    "Example warning"
  ]
}