Diagnostics

Endpoints for checking API health and testing error handling.

GET /api/v1/Diagnostics/Ping

Verifies that the API is running.

Authentication

This endpoint is public – the X-Api-Key header is not required.

Parameters

This endpoint has no parameters.

Response

200 OK

Response body: "Pong"

---

GET /api/v1/Diagnostics/Exception

Intentionally triggers a 500 server-side error. Used to verify that your integration correctly handles error responses.

Authentication

This endpoint is public – the X-Api-Key header is not required.

Response

The endpoint always returns 500 Internal Server Error with the standard error structure:

{
  "Code": "TEST_EXCEPTION",
  "Message": "This is a test exception from /Exception endpoint"
}

When to use

• Verifying that your client correctly processes error responses (ErrorDto).
• Testing retry logic and error handling.
• Verifying that an error state does not crash your integration.