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

MethodPathPurpose
POST/environmentsProvision a new environment from a Blueprint.
GET/environmentsList active and historical environments.
GET/environments/:idRetrieve full environment metadata and mesh config.
PATCH/environments/:idUpdate mutable settings (name, auto-shutdown).
DELETE/environments/:idTerminate all resources for an environment.
POST/environments/:id/stopPause environment execution.
POST/environments/:id/resumeResume execution from the last recorded state.
GET/environments/:id/statusLive service health and container status.
POST/environments/validateDry-run validation of a Blueprint YAML.
GET/environments/:id/logsFetch recent logs for an environment.
WS/environments/:id/logstreamLive log streaming for an environment.

Branching & Overlays (Branch Environments)

MethodPathPurpose
POST/baselinesPromote an environment to a stable baseline.
POST/baselines/:id/overlaysCreate a branch environment (overlay) from a baseline.
PATCH/environments/:id/shadowEnable/Disable behavioral traffic mirroring.
GET/environments/:id/diffsRetrieve behavioral diffs (Overlay vs Baseline).

Identity & Governance

MethodPathPurpose
GET/identity/verifyVerify token integrity and organization scope.
POST/auth/federation/tokenMint a short-lived federated token for cross-cluster calls.
GET/organizationFetch organization metadata and scope.
GET/organization/usagePredictive cost and infrastructure savings analysis.
GET/organization/compliance-reportBehavioral compliance and audit coverage analysis.
PATCH/organization/drift-policyUpdate organization-wide drift remediation policies.

AI & Simulation Tools

MethodPathPurpose
POST/stubs/generateGenerate service stubs from an OpenAPI spec (AI-assisted).
POST/environments/:id/diagnoseRun 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

  1. Async Operations: Resource-heavy actions like /environments (POST) return a 202 Accepted. Poll the status endpoint or subscribe to the WebSocket progress stream.
  2. 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.
  3. Rate Limiting: Standard tier accounts are limited to 100 requests/minute. Enterprise accounts have dedicated control-plane throughput quotas.
API Reference | MicroStax Documentation