Skip to main content

Health Check

Description​

Health check endpoint to verify the API server is running and responsive.

Authentication​

  • Required: No
  • Roles: None

Request​

Headers​

GET /v1/ping
Content-Type: application/json

Request Body​

No request body required.

Response​

Success Response (200)​

{
  "data": "PONG development"
}

data:

  • Type: string
  • Description: Response message indicating server status and environment

Error Responses​

  • 500: Internal server error

Example Usage​

curl -X GET https://api.stepx.io.vn/v1/ping
const response = await fetch('https://api.stepx.io.vn/v1/ping');
const data = await response.json();
console.log(data); // "PONG development"

Notes​

  • This endpoint is commonly used for health checks and monitoring
  • The response includes the current environment (development, staging, production)
  • No authentication is required for this endpoint