Ping Test

The Ping Test endpoint is used to verify the connectivity and response time of the API server. This endpoint is essential for testing the availability and performance of the server.

Endpoint

GET /api/v1/ping

Parameters

uid (query, optional):
- Description: User UUID to test get wallet balance.
- Type: string
Authorization (header, required):
- Description: Bearer Token for authentication.
- Type: string

Responses

200 OK:
- Description: The server is reachable and responding.
- Content: application/json
- Schema: types.SuccessResponse
400 Bad Request:
- Description: The request was invalid or cannot be served.
- Content: application/json
- Schema: types.ErrorResponse
500 Internal Server Error:
- Description: The server encountered an unexpected condition.
- Content: application/json
- Schema: types.ErrorResponse

Usage

This endpoint is typically used by developers to ensure that the API server is operational and can handle requests. It is a simple yet effective way to monitor server health and performance.

Example Request

GET /api/v1/ping HTTP/1.1
Host: api.example.com
Authorization: Bearer <token>

Example Response

{
  "success": true,
  "data": {}
}