API Versioning
The Thirdfort Client API is available in two versions, included in the URL path prefix of every request.
v1 (Stable)
https://api.thirdfort.com/client/api/v1/...
The v1 API is production-ready and subject to backwards-compatibility guarantees. Use v1 endpoints for all production integrations.
v1alpha2 (Preview)
https://api.thirdfort.com/client/api/v1alpha2/...
The v1alpha2 API contains preview endpoints for features that are still under development. These endpoints:
- Are not production-ready and may change without notice
- Perform real actions on real data — v1alpha2 APIs are not sandboxed; make sure you are using a nonproduction endpoint (api.thirdfort.dev) for experimentation
- Should only be used for testing new features in nonproduction environments
- Are promoted to v1 when they are stable and ready for production use
Although v1alpha2 endpoints are preview, any actions you perform (creating checks, modifying resources, etc.) affect the same underlying data as v1. Treat v1alpha2 requests with the same care as v1 requests.
Which version should I use?
Use v1 unless it does not offer the functionality you need. If you require a feature that is only available in v1alpha2, you may use it at your own risk, but we recommend limiting v1alpha2 usage to nonproduction environments.
When an endpoint is promoted from v1alpha2 to v1, the v1alpha2 version continues to work but you should migrate to the v1 equivalent at your earliest convenience.
Environments
Both API versions are available in both environments. The version is part of the URL path, not the environment:
| Environment | Base URL |
|---|---|
| Nonproduction (Sandbox) | https://api.thirdfort.dev/client/api |
| Production | https://api.thirdfort.com/client/api |
For example, to call the v1 ListChecks endpoint in production:
GET https://api.thirdfort.com/client/api/v1/{parent}/checks