API Reference
REST API reference for the MicroStax control plane. Environment lifecycle, branching, identity federation, and AI-assisted endpoints.
MicroStax API Reference
The MicroStax API is a control plane for managed Kubernetes environments. Identity and control operations are signed with a hybrid scheme that stays verifiable as cryptographic standards evolve — see the identity guide for details.
Live documentation with interactive schemas is available via the OpenAPI explorer:
Loading API reference…
Base Model & Auth
Base URL
Production: https://api.microstax.ai/v1
Local Discovery: http://localhost:3000/v1
Authentication
All authenticated requests must include a bearer token in the Authorization header:
Authorization: Bearer <token>
X-Organization-ID: <org-id>
Core Orchestration Endpoints
Environment Lifecycle
| Method | Path | Purpose |
|---|---|---|
POST | /environments | Provision a new environment from a Blueprint. |
GET | /environments | List active and historical environments. |
GET | /environments/:id | Retrieve full environment metadata and mesh config. |
PATCH | /environments/:id | Update mutable settings (name, auto-shutdown). |
DELETE | /environments/:id | Terminate all resources for an environment. |
POST | /environments/:id/stop | Pause environment execution. |
POST | /environments/:id/resume | Resume execution from the last recorded state. |
GET | /environments/:id/status | Live service health and container status. |
POST | /environments/validate | Dry-run validation of a Blueprint YAML. |
GET | /environments/:id/logs | Fetch recent logs for an environment. |
WS | /environments/:id/logstream | Live log streaming for an environment. |
Branching & Overlays (Branch Environments)
| Method | Path | Purpose |
|---|---|---|
POST | /baselines | Promote an environment to a stable baseline. |
POST | /baselines/:id/overlays | Create a branch environment (overlay) from a baseline. |
PATCH | /environments/:id/shadow | Enable/Disable behavioral traffic mirroring. |
GET | /environments/:id/diffs | Retrieve behavioral diffs (Overlay vs Baseline). |
Identity & Governance
| Method | Path | Purpose |
|---|---|---|
GET | /identity/verify | Verify token integrity and organization scope. |
POST | /auth/federation/token | Mint a short-lived federated token for cross-cluster calls. |
GET | /organization | Fetch organization metadata and scope. |
GET | /organization/usage | Predictive cost and infrastructure savings analysis. |
GET | /organization/compliance-report | Behavioral compliance and audit coverage analysis. |
PATCH | /organization/drift-policy | Update organization-wide drift remediation policies. |
AI & Simulation Tools
| Method | Path | Purpose |
|---|---|---|
POST | /stubs/generate | Generate service stubs from an OpenAPI spec (AI-assisted). |
POST | /environments/:id/diagnose | Run failure diagnosis and remediation (AI-assisted). |
Response Envelopes
Most endpoints return a standard JSON envelope to assist with client-side parsing and metadata tracking:
{
"data": { ... },
"meta": {
"requestId": "stx_5f91...",
"signatureVerified": true,
"timestamp": "2026-04-17T01:50:53Z"
}
}
Consumption Guidance
- Async Operations: Resource-heavy actions like
/environments(POST) return a202 Accepted. Poll the status endpoint or subscribe to the WebSocket progress stream. - Hybrid-signed tokens: Bearer tokens carry a classical signature plus a post-quantum signature. Standard JWT verification works today; the second proof keeps the token verifiable as cryptographic standards evolve.
- Rate Limiting: Standard tier accounts are limited to 100 requests/minute. Enterprise accounts have dedicated control-plane throughput quotas.