Skip to main content
GET
/
v1
/
ping
Ping
curl --request GET \
  --url https://{environment}.shortpen.com/v1/ping
"PONG"

Documentation Index

Fetch the complete documentation index at: https://shortpen.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to verify that your client can reach the ShortPen API host.
No authentication is required, but the route is rate limited to 30 requests per minute per IP address.
  • Returns the plain-text string PONG when the service is healthy.
  • Ideal for uptime probes and health checks before issuing authenticated calls.
  • Because the response is not JSON, you may need to force your HTTP client to treat it as plain text.

Response

API is reachable

The response is of type string.

Example:

"PONG"