Ping the server

GET/ping

Authentication

Include your API key in the x-api-key header on every request.

Response · 200 Server is alive

dataobjectrequired

messagestringrequired

callerIdstringrequired

warningsArray<string>

string

TypeScript SDKts

import { SwshApiClient } from "@somewhere-somehow/swsh-public-api";

const client = new SwshApiClient({ apiKey: process.env.SWSH_API_KEY! });

const result = await client.ping();

cURLbash

curl "https://public-api.joinswsh.com/ping" \
  -H "x-api-key: $SWSH_API_KEY"

Example response

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