API reference
MaxoPerf has two HTTP surfaces you can call. Each has a live OpenAPI reference. Pick the one that fits the workflow you are building.
Platform API
Section titled “Platform API”The Platform API covers the same workflows you do in the console: accounts, workspaces, projects, tests, runs, billing, and support. Call it from CI pipelines, scripts, and SDKs.
Open the live reference at /reference/. It shows every Platform API endpoint with request and response schemas, authentication, and examples. MaxoPerf regenerates it on every release, so it always matches the API your account uses.
Results ingest
Section titled “Results ingest”The results ingest contract is a separate HTTPS endpoint. It receives run data from authorized test engines. You normally don’t call it yourself. Maxoperf-managed runners and the agent you install for private datacenters send the data for you.
Its live reference is published the same way as the Platform API’s. On the combined reference page at /reference/, a drop-down switches between the Platform API and results ingest.
Authentication
Section titled “Authentication”- Platform API: a bearer token issued to the calling principal. Each token is scoped to one account.
- Results ingest: run-scoped, write-only credentials that MaxoPerf issues automatically for each run.
Treat every token like a password. Keep it in a secret manager, rotate it regularly, and revoke any token you think was exposed.
Common automation patterns
Section titled “Common automation patterns”| Workflow | Read this guide |
|---|---|
| Trigger a run from CI on every release candidate | Run tests from CI |
| Wait for a run to finish, then gate the build | Run tests from CI |
| Track recurring runs over time | Schedule recurring tests |
Where to go next
Section titled “Where to go next”- Public origin contract: the URLs MaxoPerf promises.
- Run tests from CI: a working example that uses the Platform API.
- Status page: check operational status before you debug an API issue.