Public origin contract
Everything you interact with as a customer is on one of a few public origins. This page is the canonical list. You don’t need to know any private URLs, port-forwards, or internal service names.
The public origins
Section titled “The public origins”| Surface | Purpose | Where you use it |
|---|---|---|
| Console | Authenticated web UI where you create tests, run them, and read results. | Browser: https://app.maxoperf.com (or your dedicated console origin). |
| Platform API | HTTPS API for automation and integrations. | CI pipelines, scripts, SDKs. |
| Results ingest | Dedicated endpoint that receives run data from authorized engines. | Engines and infrastructure with run-scoped credentials. |
| Status page | Live operational status of the MaxoPerf platform. | Anyone, no auth required. See Status page. |
| Documentation portal | The site you are reading now. | Anyone, no auth required. |
| Marketing site | Pricing, blog, comparisons, and product pages. | Anyone, no auth required. |
Stability promise
Section titled “Stability promise”- The console and Platform API are versioned. A breaking change goes through a deprecation window, announced in the release notes and on the API reference.
- Results ingest is a contract-versioned endpoint. MaxoPerf keeps the engines it authorizes in sync with it, and you don’t need to call it manually.
- The status page stays reachable even when other surfaces are degraded.
Authentication summary
Section titled “Authentication summary”- Console signs you in with single sign-on through your identity provider.
- Platform API uses bearer tokens issued from the console or from your CI integration. See Run tests from CI.
- Results ingest uses run-scoped, write-only credentials that MaxoPerf issues automatically to authorized engines.
- Status page has no authentication.
What is not a public surface
Section titled “What is not a public surface”You don’t need, and shouldn’t depend on, any of these:
- Per-service hostnames.
- Internal cluster URLs.
- Direct database, cache, or message-bus endpoints.
If you’re trying to reach something that isn’t in the list above, the workflow you want probably has a higher-level surface. Contact support if you can’t find it.
Where to go next
Section titled “Where to go next”- API reference: the full HTTP surface and request shapes.
- Status page: operational status, history, and incident updates.
- Run tests from CI: how to call the Platform API from a build pipeline.