API Reference
FreeState provides two separate APIs with complete OpenAPI specifications.
Core API
Terraform HTTP backend protocol for state storage and locking.
- API Endpoint:
api.freestate.cloud - Documentation: spec.freestate.cloud
Portal API
Administration API for user management, workspace administration, and billing.
- API Endpoint:
api.portal.freestate.cloud - Documentation: spec.portal.freestate.cloud
OpenAPI Specifications
Complete API documentation is available through interactive OpenAPI specifications:
Core API
Terraform HTTP backend protocol for state storage and locking.
- Specification: spec.freestate.cloud
Portal API
Administration API for user management, workspace administration, and billing.
- Specification: spec.portal.freestate.cloud
Visit the specification sites for complete API documentation, authentication details, and interactive testing.