v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
System

Check connectivity and authentication

This endpoint allows you to verify connectivity to the API and validate your authentication credentials. A successful response indicates that the API is reachable and your credentials are valid.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">system:read</code>

get/system/ping

Response

Success

environmentstring
timestring date-time

Example response

{
  "environment": "sandbox",
  "time": "2026-01-01T12:00:00Z"
}