Spitfirev0.62.2 · What's new

For developers

The Spitfire API

Everything the web UI, the mobile app and the CLI do goes through this HTTP API: list tests, start runs, read results, manage users with SCIM. Below, the role every endpoint needs and whether an API token may call it.

  • AuthenticationAuthorization: Bearer with a session token or an sfpat_ API token created from the user menu.
  • One envelopeEvery JSON answer is { success, data, error, traceId }; error codes are stable.
  • Paginationpage and pageSize (at most 200); the answer carries total and totalPages.

On your own Spitfire the same reference is at /api/docs, where you can try requests with your session.

Loading the reference…