Checks that the API is reachable and that replies are coming back in
the standard shape. You get data.pong: true inside the usual
{ data, meta } wrapper, and an X-Request-Id header on the reply.
You do not need a credential for this call, and that is on purpose:
a connection check has to be able to answer before you know whether
your credentials work. You may send a bearer token anyway — it is
ignored, and the reply is exactly the same with or without one.
It is one of two such paths; GET /api/v4/platform/runtime is the
other. (This paragraph said "the only path in this API that works
without one" until CU-868m279cd added that route — a universal claim
the spec made about itself, so adding a second public path had to
correct it here rather than leave it standing.)
What it means when this call fails. If you do not get the shape
shown below, the problem is with the platform or with the network, not
with your request: this path checks no fields, looks nothing up against
your company, and reads no data. So when another endpoint behaves
oddly, call this one first. It tells you whether you are looking at a
connection or deployment problem, or at something to do with your
credentials or your data.
meta carries no count. This reply is a single object rather
than a list, so meta holds only requestId and timestamp.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||