System API (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Use API credentials to check system health.

Download OpenAPI description

Servers

Generated server url

https://optimalapi-ext.apx.com/

https://optimalapi-uat-ext.apx.com/

system-v1
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Check the API system health.

Operations

Ping API, to ensure the API is available and your API credentials are valid.

Security

JWT

curl -i -X GET \
  https://optimalapi-ext.apx.com/optimal/v1/system/ping \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Bodyapplication/json

pongstring(date-time)required

The current time on the server

Response

application/json

{
  "pong": "2019-08-24T14:15:22Z"
}